#include <MHWGeometry.h>

Class Description

A list of MRenderItem objects.

A list of MRenderItem objects. All items in the list are owned by the list. This class cannot be created or destroyed, it is only passed to the user through various interfaces.

Examples:: apiDirectionalLightShape/apiDirectionalLightShape.cpp, apiMeshShape/apiMeshGeometryOverride.cpp, apiMeshShape/apiMeshGeometryOverride.h, cgFx/cgfxShaderNode.cpp, cgFx/cgfxShaderNode.h, customTextureShader/customTextureShaderOverride.cpp, customTextureShader/customTextureShaderOverride.h, dx11Shader/dx11Shader.cpp, dx11Shader/dx11Shader.h, dx11Shader/dx11ShaderOverride.cpp, dx11Shader/dx11ShaderOverride.h, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, geometryReplicator/geometryReplicator.cpp, glslShader/GLSLShaderOverride.cpp, glslShader/GLSLShaderOverride.h, gpuCache/gpuCacheSubSceneOverride.cpp, hwColorPerVertexShader/hwColorPerVertexShader.cpp, hwPhongShader/hwPhongShader.cpp, viewRenderOverride/viewRenderOverrideOperations.cpp, and vp2BlinnShader/vp2BlinnShader.cpp.

Public Member Functions
int	length () const
	Get the number of items in the list. More...

int	indexOf (const MString &name) const
	Find the index of the first render item in the list matching the given search parameters. More...

int	indexOf (const MString &name, MRenderItem::RenderItemType type) const
	Find the index of the first render item in the list matching the given search parameters. More...

int	indexOf (const MString &name, MGeometry::Primitive primitive, MGeometry::DrawMode mode) const
	Find the index of the first render item in the list matching the given search parameters. More...

const MRenderItem *	itemAt (int index) const
	Get a read-only pointer to the item at the specified index. More...

MRenderItem *	itemAt (int index)
	Get the item at the specified index. More...

bool	append (MRenderItem *item)
	Add the item to the list. More...

bool	removeAt (int index)
	Remove the item at the specified index. More...

void	clear ()
	Clear the list.

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Friends
class	MGeometryRequirements

Member Function Documentation

int length ( ) const

Get the number of items in the list.

Returns: The number of items in the list

Examples:: apiMeshShape/apiMeshGeometryOverride.cpp, cgFx/cgfxShaderNode.cpp, dx11Shader/dx11Shader.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, geometryReplicator/geometryReplicator.cpp, glslShader/GLSLShaderOverride.cpp, gpuCache/gpuCacheSubSceneOverride.cpp, hwColorPerVertexShader/hwColorPerVertexShader.cpp, hwPhongShader/hwPhongShader.cpp, viewRenderOverride/viewRenderOverrideOperations.cpp, and vp2BlinnShader/vp2BlinnShader.cpp.

int indexOf ( const MString & name ) const

Find the index of the first render item in the list matching the given search parameters.

Parameters

[in] name The name of the render item

Returns: Index of render item or -1 if not found

Examples:: apiMeshShape/apiMeshGeometryOverride.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, and geometryReplicator/geometryReplicator.cpp.

int indexOf	(	const MString &	name,
		MRenderItem::RenderItemType	type
	)		const

Find the index of the first render item in the list matching the given search parameters.

Parameters

[in]	name	The name of the render item
[in]	type	The type of the render item

Returns: Index of render item or -1 if not found

int indexOf	(	const MString &	name,
		MGeometry::Primitive	primitive,
		MGeometry::DrawMode	mode
	)		const

Find the index of the first render item in the list matching the given search parameters.

Parameters

[in]	name	The name of the render item
[in]	primitive	The primitive type of the render item
[in]	mode	The draw mode of the render item

Returns: Index of render item or -1 if not found

const MRenderItem * itemAt ( int index ) const

Get a read-only pointer to the item at the specified index.

Note, the item is owned by the list.

Parameters

[in] index Index of item.

Returns: A pointer to the item at the specified index

Examples:: apiMeshShape/apiMeshGeometryOverride.cpp, cgFx/cgfxShaderNode.cpp, dx11Shader/dx11Shader.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, geometryReplicator/geometryReplicator.cpp, glslShader/GLSLShaderOverride.cpp, gpuCache/gpuCacheSubSceneOverride.cpp, hwColorPerVertexShader/hwColorPerVertexShader.cpp, hwPhongShader/hwPhongShader.cpp, and viewRenderOverride/viewRenderOverrideOperations.cpp.

MRenderItem * itemAt ( int index )

Get the item at the specified index.

Note, the item is owned by the list.

Parameters

[in] index Index of item.

Returns: A pointer to the item at the specified index

bool append ( MRenderItem * item )

Add the item to the list.

The list assumes ownership of the item.

Parameters

[in] item The render item to add

Returns: True on successful add

Examples:: apiMeshShape/apiMeshGeometryOverride.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, and geometryReplicator/geometryReplicator.cpp.

bool removeAt ( int index )

Remove the item at the specified index.

Item is deleted.

Parameters

[in] index The item to remove

Returns: True on successful remove

const char * className ( )

static

Returns the name of this class.

Returns: The name of this class.

The documentation for this class was generated from the following files:

MHWGeometry.h
MHWGeometry.cpp

MRenderItemList Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Friends

Member Function Documentation