GeometryRenderItemHandle Class Reference

This is a special render item which used only by Mesh/MNMesh. More...

#include <GeometryRenderItemHandle.h>

Inheritance diagram for GeometryRenderItemHandle:

Public Member Functions
GraphicsDriverAPI	GeometryRenderItemHandle ()
GraphicsDriverAPI	GeometryRenderItemHandle (const GeometryRenderItemHandle &from)
GraphicsDriverAPI GeometryRenderItemHandle &	operator= (const GeometryRenderItemHandle &from)
virtual GraphicsDriverAPI	~GeometryRenderItemHandle ()
GraphicsDriverAPI void	Initialize ()
GraphicsDriverAPI void	SetRenderGeometry (IRenderGeometryPtr renderGeom)
	Set render item's render geometry. More...
GraphicsDriverAPI const IRenderGeometryPtr	GetRenderGeometry () const
	Get current render geometry. More...
GraphicsDriverAPI void	SetMaterialID (MtlID materialId)
	Set the material id of the render item. More...
GraphicsDriverAPI MtlID	GetMaterialID () const
	Get the material id of the render item. More...
Public Member Functions inherited from RenderItemHandle
GraphicsDriverAPI	RenderItemHandle ()
GraphicsDriverAPI	RenderItemHandle (const RenderItemHandle &from)
GraphicsDriverAPI RenderItemHandle &	operator= (const RenderItemHandle &from)
virtual GraphicsDriverAPI	~RenderItemHandle ()
GraphicsDriverAPI void	SetVisibilityGroup (RenderItemVisibilityGroup group)
	Set the visibility group of this render item. More...
GraphicsDriverAPI RenderItemVisibilityGroup	GetVisibilityGroup () const
	Get the visibility group of this render item. More...
GraphicsDriverAPI void	SetCustomMaterial (const BaseMaterialHandle &hMaterial)
	Set custom material for render item. More...
GraphicsDriverAPI BaseMaterialHandle	GetCustomMaterial () const
	Get custom material for render item. More...
GraphicsDriverAPI unsigned long	GetDescriptionBits () const
	Get the description bits of this render item. More...
GraphicsDriverAPI void	SetDescriptionBits (unsigned long descriptionBits)
	Set the unique ID that corresponds to the mesh element description of this render item. More...
GraphicsDriverAPI bool	GetTransparentHint () const
	Get the transparent hint of the current render item. More...
GraphicsDriverAPI void	SetTransparentHint (bool bTransparentHint)
	Set the transparent hint of the current render item. More...
GraphicsDriverAPI void	SetConsolidationData (const ConsolidationData &data)
	Set consolidation strategy and key used for consolidate this render item. More...
GraphicsDriverAPI const ConsolidationData &	GetConsolidationData ()
	Returns consolidation data of this render item. More...
GraphicsDriverAPI void	SetZBias (int bias)
	Set the item's Z bias Can be any int value. More...
GraphicsDriverAPI int	GetZBias () const
	returns the item's z bias More...
Public Member Functions inherited from SmartHandle
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 &)

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 SmartHandle
GraphicsDriverAPI	SmartHandle ()
Protected Attributes inherited from SmartHandle
IRefObject *	mpObject

Detailed Description

This is a special render item which used only by Mesh/MNMesh.

User can custom a IRenderGeometry to define what the mesh geometry looks like. Mesh and MNMesh also can generate default render geometry for this render item.

Constructor & Destructor Documentation

GeometryRenderItemHandle() [1/2]

GraphicsDriverAPI GeometryRenderItemHandle

(

)

GeometryRenderItemHandle() [2/2]

GraphicsDriverAPI GeometryRenderItemHandle

(

const GeometryRenderItemHandle &

from

)

~GeometryRenderItemHandle()

virtual GraphicsDriverAPI ~GeometryRenderItemHandle ( )

virtual

Member Function Documentation

operator=()

GraphicsDriverAPI GeometryRenderItemHandle& operator=

(

const GeometryRenderItemHandle &

from

)

Initialize()

GraphicsDriverAPI void Initialize

(

)

SetRenderGeometry()

GraphicsDriverAPI void SetRenderGeometry

(

IRenderGeometryPtr

renderGeom

)

Set render item's render geometry.

Render items without render geometry will be ignored when rendering.

Parameters

renderGeom

the render geometry instance

GetRenderGeometry()

GraphicsDriverAPI const IRenderGeometryPtr GetRenderGeometry

(

)

const

Get current render geometry.

Returns

reference current render geometry

SetMaterialID()

GraphicsDriverAPI void SetMaterialID

(

MtlID

materialId

)

Set the material id of the render item.

By default the material id of a tuple mesh render item is zero. However if the parent node of the render item has a multi/sub material, then it is necessary to specify which sub material is used by this render item.

Parameters

materialId

the material id of the render item. It is actually an index to a sub material and starts from zero.

GetMaterialID()

GraphicsDriverAPI MtlID GetMaterialID

(

)

const

Get the material id of the render item.