This reference page is linked to from the following overview topics: Implementing Advanced Material and Texture Map Plug-ins with Nitrous, About RenderItem.
#include <RenderItemHandle.h>
This is the base wrapper class for all viewport render items.
A render item is the primary drawable element that holds the geometry. A plugin object that wants to be displayed in the viewport needs to create and maintain a set of concrete derived render items like TupleMeshRenderItem and expose those render items to max via the IObjectDisplay interface.
Public Member Functions |
|
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. |
|
GraphicsDriverAPI RenderItemVisibilityGroup |
GetVisibilityGroup () const |
Get the visibility group of this render
item. |
|
MAX_DEPRECATED GraphicsDriverAPI void |
SetCategory (RenderItemCategory category) |
MAX_DEPRECATED GraphicsDriverAPI RenderItemCategory |
GetCategory () const |
GraphicsDriverAPI void | SetCustomMaterial (const BaseMaterialHandle &hMaterial) |
Set custom material for render item.
|
|
GraphicsDriverAPI BaseMaterialHandle |
GetCustomMaterial () const |
Get custom material for render item.
|
|
GraphicsDriverAPI unsigned long | GetDescriptionBits () const |
Get the description bits of this render
item. |
|
GraphicsDriverAPI void | SetDescriptionBits (unsigned long descriptionBits) |
Set the unique ID that corresponds to the
mesh element description of this render item. |
|
GraphicsDriverAPI bool | GetTransparentHint () const |
Get the transparent hint of the current
render item. |
|
GraphicsDriverAPI void | SetTransparentHint (bool bTransparentHint) |
Set the transparent hint of the current
render item. |
GraphicsDriverAPI RenderItemHandle | ( | ) |
GraphicsDriverAPI RenderItemHandle | ( | const RenderItemHandle & | from | ) |
virtual GraphicsDriverAPI ~RenderItemHandle | ( | ) | [virtual] |
GraphicsDriverAPI RenderItemHandle& operator= | ( | const RenderItemHandle & | from | ) |
GraphicsDriverAPI void SetVisibilityGroup | ( | RenderItemVisibilityGroup | group | ) |
Set the visibility group of this render item.
group | the visibility group of this render item. |
GraphicsDriverAPI RenderItemVisibilityGroup GetVisibilityGroup | ( | ) | const |
Get the visibility group of this render item.
MAX_DEPRECATED GraphicsDriverAPI void SetCategory | ( | RenderItemCategory | category | ) |
Please use SetDescriptionBits()
MAX_DEPRECATED GraphicsDriverAPI RenderItemCategory GetCategory | ( | ) | const |
Please use GetDescriptionBits()
GraphicsDriverAPI void SetCustomMaterial | ( | const BaseMaterialHandle & | hMaterial | ) |
Set custom material for render item.
By default, render item uses the material from node. When a custom material is set, the render item will use the set material.
hMaterial | The material handle. |
GraphicsDriverAPI BaseMaterialHandle GetCustomMaterial | ( | ) | const |
GraphicsDriverAPI unsigned long GetDescriptionBits | ( | ) | const |
Get the description bits of this render item.
The description bits correspond to a specific type of mesh element description. Developers may use it to query a render item from an IRenderItemContainer.
GraphicsDriverAPI void SetDescriptionBits | ( | unsigned long | descriptionBits | ) |
Set the unique ID that corresponds to the mesh element description of this render item.
descriptionBits | the description bits |
GraphicsDriverAPI bool GetTransparentHint | ( | ) | const |
Get the transparent hint of the current render item.
This hint could helper decide whether to place an render item in transparent pass or opaque pass.
GraphicsDriverAPI void SetTransparentHint | ( | bool | bTransparentHint | ) |
Set the transparent hint of the current render item.
bTransparentHint | The transparent hint. |