CompoundObjectAddRenderItemsHelper Class Reference
 
 
 
CompoundObjectAddRenderItemsHelper Class Reference

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


#include <SubobjectDisplayUtility.h>

Inheritance diagram for CompoundObjectAddRenderItemsHelper:
IAddRenderItemsHelper BaseInterface InterfaceServer MaxHeapOperators

Class Description

This is the utility AddRenderItemsHelper class for any compound object that would like to customize the display of its child-objects.

Public Member Functions

GraphicsDriverAPI  CompoundObjectAddRenderItemsHelper (BaseObject *pCompoundObject)
  Default constructor.
GraphicsDriverAPI  ~CompoundObjectAddRenderItemsHelper ()
GraphicsDriverAPI void  AddChildObjectRenderItems (const MaxContext &maxContext, RenderNodeHandle &hTargetNode, IRenderItemContainer &targetRenderItemContainer, BaseObject *pChildObject, LONG_PTR objectData)
  Call this function if you'd customize the display of the specified child-object so as to add all of its render items.

Protected Member Functions

virtual
ChildObjectDisplayCallback
CreateChildObjectDisplayCallback (BaseObject *pChildObject, LONG_PTR objectData)=0
  Implement this virtual function to create a concrete ChildObjectDisplayCallback instance related with the specified child object.

Protected Attributes

BaseObject mpParentObject

Constructor & Destructor Documentation

GraphicsDriverAPI CompoundObjectAddRenderItemsHelper ( BaseObject pCompoundObject )

Default constructor.

Parameters:
pCompoundObject the compound object that will add its render item
GraphicsDriverAPI ~CompoundObjectAddRenderItemsHelper ( )

Member Function Documentation

GraphicsDriverAPI void AddChildObjectRenderItems ( const MaxContext maxContext,
RenderNodeHandle hTargetNode,
IRenderItemContainer targetRenderItemContainer,
BaseObject pChildObject,
LONG_PTR  objectData 
)

Call this function if you'd customize the display of the specified child-object so as to add all of its render items.

Parameters:
maxContext Contains all viewports in which the object will be displayed.
hTargetNode the render node handle that reference the plugin object.
targetRenderItemContainer the target render item container to which this plugin object will be added.
pChildObject the specified child object
objectData object data related with pChildObject
Remarks:
objectData would be passed to CreateChildObjectDisplayCallback() when the ChildObjectDisplayCallback instance associated with pChildObject will be created.
virtual ChildObjectDisplayCallback* CreateChildObjectDisplayCallback ( BaseObject pChildObject,
LONG_PTR  objectData 
) [protected, pure virtual]

Implement this virtual function to create a concrete ChildObjectDisplayCallback instance related with the specified child object.

Parameters:
pChildObject the specified child-object
objectData object data passed through when calling AddChildObjectRenderItems()
Remarks:
Developer should implement the concrete ChildObjectDisplayCallback class to customize the display of all child render items in IDisplayCallback::DoDisplay()

Member Data Documentation