SharedMesh Class Reference

SharedMesh is a class to share a mesh between different classes. More...

#include <SharedMesh.h>

Inheritance diagram for SharedMesh:

Public Member Functions
DllExport	SharedMesh ()
virtual DllExport	~SharedMesh ()
DllExport const Mesh &	GetMesh () const
DllExport Mesh &	GetMesh ()
DllExport const Mesh *	GetMeshPtr () const
DllExport Mesh *	GetMeshPtr ()
Public Member Functions inherited from ARefObject
GraphicsUtilityAPI	ARefObject ()
virtual GraphicsUtilityAPI long	AddRef ()
	from IRefObject, see comments in IRefObject
virtual GraphicsUtilityAPI long	Release ()
	decrease reference count of this object by one, if the decreased reference count equals zero, the object will be deleted.
GraphicsUtilityAPI IRefObject *	QueryInterface (Interface_ID classID)
	Try query an interface from the ref object using a given interface id.
Public Member Functions inherited from IRefObject
GraphicsUtilityAPI	IRefObject ()
virtual GraphicsUtilityAPI	~IRefObject ()
virtual long	AddRef ()=0
	increase reference count of this object by one
virtual long	Release ()=0
	decrease reference count of this object by one, if the decreased reference count equals zero, the object will be deleted.
virtual IRefObject *	QueryInterface (Interface_ID interfaceID)=0
	Try query an interface from the ref object using a given interface id.

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Protected Member Functions inherited from ARefObject
virtual GraphicsUtilityAPI void	DeleteThis ()
	This function will be called when the reference count of an ARefObject equals zero.
virtual GraphicsUtilityAPI	~ARefObject ()

Detailed Description

SharedMesh is a class to share a mesh between different classes.

It uses reference counting and gets deleted once its ref count reaches 0.

See also

Class ARefObject. Usage is : In class A, a member is SharedMeshPtr mMeshPtr; In one of A's method : mMeshPtr = new SharedMesh(); //ref count is 1; No need to do a mMeshPtr->Release() in A::~A() since we use a Ref<> pointer. When A is deleted, the ref count of mMeshPtr will decrease automatically. And in another class B : you have another member SharedMeshPtr mAnotherMeshPtr; //Share the mesh between the 2 classes mAnotherMeshPtr = mMeshPtr;//ref count is 2, the SharedMesh will be deleted automatically when both SharedMeshPtr instances are deleted. Use the mesh data : if (nullptr != mAnotherMeshPtr){ const int numVertices = mAnotherMeshPtr.GetMesh().numverts; }

Constructor & Destructor Documentation

SharedMesh()

DllExport SharedMesh

(

)

~SharedMesh()

virtual DllExport ~SharedMesh ( )

virtual

Member Function Documentation

GetMesh() [1/2]

DllExport const Mesh & GetMesh ( ) const

inline

{return mMesh;}

GetMesh() [2/2]

DllExport Mesh & GetMesh ( )

inline

{return mMesh;}

GetMeshPtr() [1/2]

DllExport const Mesh * GetMeshPtr ( ) const

inline

{return &mMesh;}

GetMeshPtr() [2/2]

DllExport Mesh * GetMeshPtr ( )

inline

{return &mMesh;}