GeometryRenderItemHandle Class Reference
 
 
 
GeometryRenderItemHandle Class Reference

This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions, About SmartHandle, About RenderItem.


#include <GeometryRenderItemHandle.h>

Inheritance diagram for GeometryRenderItemHandle:
RenderItemHandle SmartHandle Noncopyable MaxHeapOperators

Class 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.

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.
GraphicsDriverAPI const
IRenderGeometryPtr 
GetRenderGeometry ()
  Get current render geometry.
GraphicsDriverAPI void  SetMaterialID (MtlID materialId)
  Set the material id of the render item.
GraphicsDriverAPI MtlID  GetMaterialID () const
  Get the material id of the render item.

Constructor & Destructor Documentation

GraphicsDriverAPI GeometryRenderItemHandle ( )
GraphicsDriverAPI GeometryRenderItemHandle ( const GeometryRenderItemHandle from )
virtual GraphicsDriverAPI ~GeometryRenderItemHandle ( ) [virtual]

Member Function Documentation

GraphicsDriverAPI GeometryRenderItemHandle& operator= ( const GeometryRenderItemHandle from )
GraphicsDriverAPI void Initialize ( )
GraphicsDriverAPI void SetRenderGeometry ( IRenderGeometryPtr  renderGeom )

Set render item's render geometry.

Render items without render geometry will be ignored when rendering.

Parameters:
renderGeometry the render geometry instance
GraphicsDriverAPI const IRenderGeometryPtr GetRenderGeometry ( )

Get current render geometry.

Returns:
reference current render geometry
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.
GraphicsDriverAPI MtlID GetMaterialID ( ) const

Get the material id of the render item.