RenderItemHandle Class Reference
Detailed Description
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.
- See also:
- Class IObjectDisplay, IGeometryDisplay
#include <RenderItemHandle.h>
Public Member Functions |
|
| GraphicsDriverAPI | RenderItemHandle () |
| GraphicsDriverAPI | RenderItemHandle (const RenderItemHandle &from) |
|
GraphicsDriverAPI RenderItemHandle & |
operator= (const RenderItemHandle &from) |
| virtual GraphicsDriverAPI | ~RenderItemHandle () |
| GraphicsDriverAPI void | SetCategory (RenderItemCategory category) |
| Sets the category of the render item.
|
|
|
GraphicsDriverAPI RenderItemCategory |
GetCategory () const |
| Gets the category of the render item.
|
|
|
MAX_DEPRECATED GraphicsDriverAPI void |
SetCustomMaterial (const BaseMaterialHandle &hMaterial) |
|
MAX_DEPRECATED GraphicsDriverAPI BaseMaterialHandle |
GetCustomMaterial () const |
Constructor & Destructor Documentation
| GraphicsDriverAPI RenderItemHandle | ( | ) |
| GraphicsDriverAPI RenderItemHandle | ( | const RenderItemHandle & | from | ) |
| virtual GraphicsDriverAPI ~RenderItemHandle | ( | ) | [virtual] |
Member Function Documentation
| GraphicsDriverAPI RenderItemHandle& operator= | ( | const RenderItemHandle & | from | ) |
| GraphicsDriverAPI void SetCategory | ( | RenderItemCategory | category | ) |
Sets the category of the render item.
- Remarks:
- Each render item belongs to a category. category controls the visibility of the render item at a specific render category pass. For example: Wireframe pass. For more information please see enum RenderItemCategory.
By default the category of a render item is RenderItemCategoryGizmo.
- Parameters:
-
category The category of this render item.
| GraphicsDriverAPI RenderItemCategory GetCategory | ( | ) | const |
Gets the category of the render item.
- Returns:
- the category of the render item.
| MAX_DEPRECATED GraphicsDriverAPI void SetCustomMaterial | ( | const BaseMaterialHandle & | hMaterial | ) |
- Deprecated:
- Deprecated in 3ds Max 2012.
No replacement. 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.
- Parameters:
-
hMaterial The material handle.
| MAX_DEPRECATED GraphicsDriverAPI BaseMaterialHandle GetCustomMaterial | ( | ) | const |
- Deprecated:
- Deprecated in 3ds Max 2012.
No replacement. Get custom material for render item.
- Returns:
- the custom material.
