SmartHandle Class Reference

This is the base wrapper class for all graphics primitive classes in max viewport: worlds, nodes, render items, materials, etc. More...

#include <SmartHandle.h>

Inheritance diagram for SmartHandle:

Public Member Functions
virtual GraphicsDriverAPI	~SmartHandle ()
	destructor More...
GraphicsDriverAPI bool	IsValid () const
	Check if this handle is valid. More...
GraphicsDriverAPI void	Release ()
	Release the underlying graphics objects. More...
GraphicsDriverAPI Identifier	GetObjectID () const
	Get the underlying graphics object id. More...
GraphicsDriverAPI void	SetPointer (IRefObject *pObject)
GraphicsDriverAPI IRefObject *	GetPointer () const
	Get the underlying graphics object pointer. More...
bool	operator== (const SmartHandle &rhs) const
bool	operator!= (const SmartHandle &rhs) const
bool	operator< (const SmartHandle &rhs) const
bool	operator<= (const SmartHandle &rhs) const
bool	operator> (const SmartHandle &rhs) const
bool	operator>= (const SmartHandle &rhs) const
GraphicsDriverAPI	SmartHandle (const SmartHandle &)
GraphicsDriverAPI SmartHandle &	operator= (const SmartHandle &)

Protected Member Functions
GraphicsDriverAPI	SmartHandle ()

Protected Attributes
IRefObject *	mpObject

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

This is the base wrapper class for all graphics primitive classes in max viewport: worlds, nodes, render items, materials, etc.

It contains internal graphics object pointer and holds a reference to that pointer. It will release its reference to graphics object in its destructor.

Note this is not for generic smart handle use.

Constructor & Destructor Documentation

~SmartHandle()

virtual GraphicsDriverAPI ~SmartHandle ( )

virtual

destructor

SmartHandle() [1/2]

GraphicsDriverAPI SmartHandle

(

const SmartHandle &

)

SmartHandle() [2/2]

GraphicsDriverAPI SmartHandle ( )

protected

Member Function Documentation

IsValid()

GraphicsDriverAPI bool IsValid

(

)

const

Check if this handle is valid.

User should never call member functions of an invalid handle.

Release()

GraphicsDriverAPI void Release

(

)

Release the underlying graphics objects.

After calling this function, any function of the same SmartHandle instance should not be used.

GetObjectID()

GraphicsDriverAPI Identifier GetObjectID

(

)

const

Get the underlying graphics object id.

This function is internally used only.

SetPointer()

GraphicsDriverAPI void SetPointer

(

IRefObject *

pObject

)

GetPointer()

GraphicsDriverAPI IRefObject* GetPointer

(

)

const

Get the underlying graphics object pointer.

This function is internally used only.

operator==()

bool operator== ( const SmartHandle &  rhs ) const

inline

                                                           {
        return mpObject == rhs.mpObject;
    }

operator!=()

bool operator!= ( const SmartHandle &  rhs ) const

inline

                                                           {
        return mpObject != rhs.mpObject;
    }

operator<()

bool operator< ( const SmartHandle &  rhs ) const

inline

                                                          {
        return mpObject < rhs.mpObject;
    }

operator<=()

bool operator<= ( const SmartHandle &  rhs ) const

inline

                                                           {
        return mpObject <= rhs.mpObject;
    }

operator>()

bool operator> ( const SmartHandle &  rhs ) const

inline

                                                          {
        return mpObject > rhs.mpObject;
    }

operator>=()

bool operator>= ( const SmartHandle &  rhs ) const

inline

                                                           {
        return mpObject >= rhs.mpObject;
    }

operator=()

GraphicsDriverAPI SmartHandle& operator=

(

const SmartHandle &

)

Member Data Documentation

mpObject

IRefObject* mpObject

protected