UpdateDisplayContext Class Reference
 
 
 
UpdateDisplayContext Class Reference

This reference page is linked to from the following overview topics: Porting Object Plug-ins to Nitrous, About RenderItem.


#include <UpdateDisplayContext.h>

Inheritance diagram for UpdateDisplayContext:
MaxHeapOperators

Class Description

This class contains all information that will be passed to IObjectDisplay::UpdateDisplay and will be used by plugin to update its display data.

All the value of this class are set by system and plugin developers should build render items to satisfy those requirements.

Public Member Functions

GraphicsDriverAPI  UpdateDisplayContext ()
virtual GraphicsDriverAPI  ~UpdateDisplayContext ()
GraphicsDriverAPI unsigned long  GetRequiredComponents () const
  Get component requirement flags.
GraphicsDriverAPI void  SetRequiredComponents (unsigned long requiredComponent)
  Set component requirement flags.
GraphicsDriverAPI void  ClearRequiredStreams ()
  Clear the required stream of this class.
GraphicsDriverAPI const
MaterialRequiredStreams
GetRequiredStreams () const
  Get the required streams.
GraphicsDriverAPI
MaterialRequiredStreams
GetRequiredStreams ()
  Get the required streams.
GraphicsDriverAPI void  AddRequiredStreams (const MaterialRequiredStreams &requiredStreams)
  Add stream requirements, so that the new requirement of the UpdateDisplayContext contains both old requirement and the newly input requirement.
GraphicsDriverAPI void  SetDisplayTime (TimeValue t)
  Set the display time of this UpdateDisplayContext.
GraphicsDriverAPI TimeValue  GetDisplayTime () const
  Get the display time.
GraphicsDriverAPI size_t  GetNumberOfOwnerNodes () const
  Get the number of nodes that reference the plugin object.
GraphicsDriverAPI INode GetOwnerNode (size_t i) const
  Get the i-th owner node of the array.
MAX_DEPRECATED
GraphicsDriverAPI void 
RemoveAllOwnerNodes ()
MAX_DEPRECATED
GraphicsDriverAPI void 
AddOwnerNode (INode *pNode)

Protected Attributes

void *  mpImpl

Constructor & Destructor Documentation

GraphicsDriverAPI UpdateDisplayContext ( )
virtual GraphicsDriverAPI ~UpdateDisplayContext ( ) [virtual]

Member Function Documentation

GraphicsDriverAPI unsigned long GetRequiredComponents ( ) const

Get component requirement flags.

Component requirement flag is decided by current viewport configuration: visual style, edged faces, etc. and node display properties: backface cull, vertex ticks, etc.

See also:
ObjectComponentRequirement
Returns:
A combination of RenderItemCategory
GraphicsDriverAPI void SetRequiredComponents ( unsigned long  requiredComponent )

Set component requirement flags.

See also:
ObjectComponentRequirement
Parameters:
requiredComponent A combination of RenderItemCategory
GraphicsDriverAPI void ClearRequiredStreams ( )

Clear the required stream of this class.

GraphicsDriverAPI const MaterialRequiredStreams& GetRequiredStreams ( ) const

Get the required streams.

Required streams is for generating mesh render items.

See also:
MaterialRequiredStreams
GraphicsDriverAPI MaterialRequiredStreams& GetRequiredStreams ( )

Get the required streams.

Required streams is for generating mesh render items.

See also:
MaterialRequiredStreams
GraphicsDriverAPI void AddRequiredStreams ( const MaterialRequiredStreams requiredStreams )

Add stream requirements, so that the new requirement of the UpdateDisplayContext contains both old requirement and the newly input requirement.

See also:
MaterialRequiredStreams
Parameters:
[in] requiredStreams the requirement to be added.
GraphicsDriverAPI void SetDisplayTime ( TimeValue  t )

Set the display time of this UpdateDisplayContext.

The display time is not necessarily the current time of 3ds max. This allows viewport to display objects with different time.

Parameters:
[in] t The current time.
GraphicsDriverAPI TimeValue GetDisplayTime ( ) const

Get the display time.

Returns:
the current time.
GraphicsDriverAPI size_t GetNumberOfOwnerNodes ( ) const

Get the number of nodes that reference the plugin object.

Returns:
the number of owner nodes.
GraphicsDriverAPI INode* GetOwnerNode ( size_t  i ) const

Get the i-th owner node of the array.

Parameters:
[in] i the index of the node in this context.
Returns:
the i-th owner node.
MAX_DEPRECATED GraphicsDriverAPI void RemoveAllOwnerNodes ( )
Deprecated:
Deprecated method in terms of implementation as of 3ds Max 2013, NOTE : There's no replacement for this function.
MAX_DEPRECATED GraphicsDriverAPI void AddOwnerNode ( INode pNode )
Deprecated:
Deprecated method in terms of implementation as of 3ds Max 2013, NOTE : There's no replacement for this function.

Member Data Documentation