CustomRenderItemHandle Class Reference
 
 
 
CustomRenderItemHandle Class Reference

This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions, About RenderItem, Low-level Device API.


#include <CustomRenderItemHandle.h>

Inheritance diagram for CustomRenderItemHandle:
RenderItemHandle SmartHandle Noncopyable MaxHeapOperators

Class Description

CustomRenderItemHandle is a wrapper of ICustomRenderItem.

It is used to add user-custom implementation into Max graphic system without direct derive from RenderItemHandle.

Public Member Functions

GraphicsDriverAPI  CustomRenderItemHandle ()
GraphicsDriverAPI  CustomRenderItemHandle (const CustomRenderItemHandle &from)
GraphicsDriverAPI
CustomRenderItemHandle
operator= (const CustomRenderItemHandle &from)
virtual GraphicsDriverAPI  ~CustomRenderItemHandle ()
GraphicsDriverAPI void  Initialize ()
  Initialize this handle.
GraphicsDriverAPI void  SetCustomImplementation (ICustomRenderItem *impl)
  Set a ICustomRenderItem object to this handle.
GraphicsDriverAPI
ICustomRenderItem
GetCustomeImplementation () const
  Get the ICustomRenderItem object in this handle.

Constructor & Destructor Documentation

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

Member Function Documentation

GraphicsDriverAPI CustomRenderItemHandle& operator= ( const CustomRenderItemHandle from )
GraphicsDriverAPI void Initialize ( )

Initialize this handle.

The handle is empty after initialization. It doesn't have default implementation.

GraphicsDriverAPI void SetCustomImplementation ( ICustomRenderItem impl )

Set a ICustomRenderItem object to this handle.

Parameters:
[in] impl User created class which derives from ICustomRenderItem interface.
GraphicsDriverAPI ICustomRenderItem* GetCustomeImplementation ( ) const

Get the ICustomRenderItem object in this handle.

Returns:
the ICustomRenderItem object. nullptr if no implementation.