MeshElementDescription Class Reference

This class describes a single mesh element(which corresponds to a render item) required to be generated by calling Mesh::GenerateRenderItems() or MNMesh::GenerateRenderItems() from the specified mesh(or mnmesh). More...

#include <MeshElementDescription.h>

Inheritance diagram for MeshElementDescription:

Public Member Functions
GraphicsDriverAPI	MeshElementDescription ()
GraphicsDriverAPI	MeshElementDescription (unsigned long descriptionBits)
GraphicsDriverAPI	~MeshElementDescription ()
GraphicsDriverAPI	MeshElementDescription (const MeshElementDescription &from)
GraphicsDriverAPI MeshElementDescription &	operator= (const MeshElementDescription &from)
GraphicsDriverAPI MeshElementType	GetMeshElementType () const
	Get the type of this mesh element. More...
GraphicsDriverAPI void	SetMeshElementType (MeshElementType type)
	Set the type of this mesh element. More...
GraphicsDriverAPI MeshPart	GetMeshPart () const
	Get the part of this mesh element. More...
GraphicsDriverAPI void	SetMeshPart (MeshPart meshPart)
	Set the part of this mesh element. More...
GraphicsDriverAPI void	SetUseSoftSelectionColor (bool onOff)
	Specify whether to shade the mesh element in soft selection color. More...
GraphicsDriverAPI bool	GetUseSoftSelectionColor () const
	Get whether to shade the mesh element in soft selection color. More...
GraphicsDriverAPI bool	GetBackfaceCull () const
	Get whether the mesh element requires its back faces to be culled. More...
GraphicsDriverAPI void	SetBackfaceCull (bool onOff)
	Specify whether the mesh element requires its back faces to be culled. More...
GraphicsDriverAPI unsigned long	GetDescriptionBits () const
	Get the description bits of this element description. More...

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 class describes a single mesh element(which corresponds to a render item) required to be generated by calling Mesh::GenerateRenderItems() or MNMesh::GenerateRenderItems() from the specified mesh(or mnmesh).

Constructor & Destructor Documentation

MeshElementDescription() [1/3]

GraphicsDriverAPI MeshElementDescription

(

)

MeshElementDescription() [2/3]

GraphicsDriverAPI MeshElementDescription

(

unsigned long

descriptionBits

)

~MeshElementDescription()

GraphicsDriverAPI ~MeshElementDescription

(

)

MeshElementDescription() [3/3]

GraphicsDriverAPI MeshElementDescription

(

const MeshElementDescription &

from

)

Member Function Documentation

operator=()

GraphicsDriverAPI MeshElementDescription& operator=

(

const MeshElementDescription &

from

)

GetMeshElementType()

GraphicsDriverAPI MeshElementType GetMeshElementType

(

)

const

Get the type of this mesh element.

Returns

the mesh element type.

SetMeshElementType()

GraphicsDriverAPI void SetMeshElementType

(

MeshElementType

type

)

Set the type of this mesh element.

Parameters

type	The specified mesh element type.

GetMeshPart()

GraphicsDriverAPI MeshPart GetMeshPart

(

)

const

Get the part of this mesh element.

Returns

the mesh part.

SetMeshPart()

GraphicsDriverAPI void SetMeshPart

(

MeshPart

meshPart

)

Set the part of this mesh element.

Parameters

meshPart

The specified mesh part.

SetUseSoftSelectionColor()

GraphicsDriverAPI void SetUseSoftSelectionColor

(

bool

onOff

)

Specify whether to shade the mesh element in soft selection color.

Turn on this option when an mesh element is displayed in any sub-object level using soft selection

Parameters

onOff

True to enable and false to disable.

Remarks

this option has no effect an a mesh element whose MeshPart is MeshPartSelected. The selected edge/diagonal/face mesh element will always be shaded in red. For the vertex ticks mesh element, when this option "on" its selected vertices will be displayed in red while the unselected ones will be shaded in soft selection color. And when "off", all vertices will be shaded in soft selection color.

GetUseSoftSelectionColor()

GraphicsDriverAPI bool GetUseSoftSelectionColor

(

)

const

Get whether to shade the mesh element in soft selection color.

Returns

true if shaded in soft selection color or false otherwise.

GetBackfaceCull()

GraphicsDriverAPI bool GetBackfaceCull

(

)

const

Get whether the mesh element requires its back faces to be culled.

Returns

whether to cull the back face.

SetBackfaceCull()

GraphicsDriverAPI void SetBackfaceCull

(

bool

onOff

)

Specify whether the mesh element requires its back faces to be culled.

Parameters

onOff

whether to cull the back face.

GetDescriptionBits()

GraphicsDriverAPI unsigned long GetDescriptionBits

(

)

const

Get the description bits of this element description.

This value is a combination of all member values on bit base and corresponds to a specific type of mesh element description. Developers may use it to query a render item from an IRenderItemContainer.

Returns

the description bits corresponding to this element description