MeshEdgeKey Class Reference

This is a utility class for provide a key for MeshEdgeRenderItem. More...

#include <MeshEdgeRenderItem.h>

Inheritance diagram for MeshEdgeKey:

Public Member Functions
DefaultRenderItemAPI	MeshEdgeKey ()
DefaultRenderItemAPI	MeshEdgeKey (MeshEdgeKey &from)
DefaultRenderItemAPI	~MeshEdgeKey ()
DefaultRenderItemAPI MeshEdgeKey *	operator= (const MeshEdgeKey &rhs)
virtual DefaultRenderItemAPI void	SetFixedSize (bool value)
	Set whether the mesh item is fixed size on screen. More...
virtual DefaultRenderItemAPI bool	GetFixedSize ()
	Return if the mesh item is fixed size on screen. More...
virtual DefaultRenderItemAPI void	SetBackfaceCull (bool value)
	Sets whether the mesh item needs back-face cull. More...
virtual DefaultRenderItemAPI bool	GetBackfaceCull ()
virtual DefaultRenderItemAPI IConsolidationKey *	Clone ()
	Create an new instance of the key. More...
virtual DefaultRenderItemAPI size_t	GetHashKey ()
	Get hash key that combines properties of this key. More...
virtual DefaultRenderItemAPI bool	Equals (const IConsolidationKey &rhs) const
	Compares another key. More...
virtual DefaultRenderItemAPI const Class_ID	GetClassID () const
	Get the key's class ID. More...
Public Member Functions inherited from IConsolidationKey
GraphicsDriverAPI bool	operator== (const IConsolidationKey &rhs) const
	Same as Equals(), returns the comparison of two keys. More...
Public Member Functions inherited from ARefObject
GraphicsUtilityAPI	ARefObject ()
virtual GraphicsUtilityAPI long	AddRef ()
	from IRefObject, see comments in IRefObject More...
virtual GraphicsUtilityAPI long	Release ()
	decrease reference count of this object by one, if the decreased reference count equals zero, the object will be deleted. More...
GraphicsUtilityAPI IRefObject *	QueryInterface (Interface_ID classID)
	Try query an interface from the ref object using a given interface id. More...
Public Member Functions inherited from IRefObject
GraphicsUtilityAPI	IRefObject ()
virtual GraphicsUtilityAPI	~IRefObject ()

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...
Protected Member Functions inherited from ARefObject
virtual GraphicsUtilityAPI void	DeleteThis ()
	This function will be called when the reference count of an ARefObject equals zero. More...
virtual GraphicsUtilityAPI	~ARefObject ()

Detailed Description

This is a utility class for provide a key for MeshEdgeRenderItem.

Constructor & Destructor Documentation

MeshEdgeKey() [1/2]

DefaultRenderItemAPI MeshEdgeKey

(

)

MeshEdgeKey() [2/2]

DefaultRenderItemAPI MeshEdgeKey

(

MeshEdgeKey &

from

)

~MeshEdgeKey()

DefaultRenderItemAPI ~MeshEdgeKey

(

)

Member Function Documentation

operator=()

DefaultRenderItemAPI MeshEdgeKey* operator=

(

const MeshEdgeKey &

rhs

)

SetFixedSize()

virtual DefaultRenderItemAPI void SetFixedSize ( bool  value )

virtual

Set whether the mesh item is fixed size on screen.

Parameters

value

true means the mesh is fixed size. Otherwise false.

GetFixedSize()

virtual DefaultRenderItemAPI bool GetFixedSize ( )

virtual

Return if the mesh item is fixed size on screen.

Returns

true if it's fixed size. Otherwise false.

SetBackfaceCull()

virtual DefaultRenderItemAPI void SetBackfaceCull ( bool  value )

virtual

Sets whether the mesh item needs back-face cull.

Parameters

value

true means it needs back-face cull. Otherwise false.

GetBackfaceCull()

virtual DefaultRenderItemAPI bool GetBackfaceCull ( )

virtual

Returns

true if the item needs back-face cull. Otherwise false.

Clone()

virtual DefaultRenderItemAPI IConsolidationKey* Clone ( )

virtual

Create an new instance of the key.

Returns

new instance of the key which contains same value.

Implements IConsolidationKey.

GetHashKey()

virtual DefaultRenderItemAPI size_t GetHashKey ( )

virtual

Get hash key that combines properties of this key.

Returns

hash key

Implements IConsolidationKey.

Equals()

virtual DefaultRenderItemAPI bool Equals ( const IConsolidationKey &  rhs ) const

virtual

Compares another key.

Parameters

rhs	another consolidation key which has same hash key

Returns

true if both values are same. Otherwise false.

Implements IConsolidationKey.

GetClassID()

virtual DefaultRenderItemAPI const Class_ID GetClassID ( ) const

virtual

Get the key's class ID.

Returns

class ID of the key

Implements IConsolidationKey.