Detailed Description

See also:: Class IRenderElement, Class FPMixinInterface, Class ReferenceTarget, Render Elements

Description:: This class is available in release 4.0 and later only.

This class represents the interface for the Render Element Manager. A sample plugin of a Render Element can be found in the SDK samples; /MAXSDK/SAMPLES/RENDER/RENDERELEMENTS.

#include <renderelements.h>

Inheritance diagram for IRenderElementMgr:

Public Types
enum	{ fps_AddRenderElement, fps_RemoveRenderElement, fps_RemoveAllRenderElements, fps_NumRenderElements, fps_GetRenderElement, fps_SetElementsActive, fps_GetElementsActive, fps_SetDisplayElements, fps_GetDisplayElements, fps_SetCombustionOutputEnabled, fps_GetCombustionOutputEnabled, fps_SetCombustionOutputPath, fps_GetCombustionOutputPath, fps_SetRenderElementFilename, fps_GetRenderElementFilename }
Public Member Functions
virtual BOOL	AppendMergedRenderElement (IRenderElement *pRenderElement)=0
virtual BOOL	AppendMergedRenderElement (ReferenceTarget *pRenderElement)=0
virtual BOOL	AddRenderElement (IRenderElement *pRenderElement)=0
virtual BOOL	AddRenderElement (ReferenceTarget *pRenderElement)=0
virtual BOOL	RemoveRenderElement (IRenderElement *pRenderElement)=0
virtual BOOL	RemoveRenderElement (ReferenceTarget *pRenderElement)=0
virtual void	RemoveAllRenderElements ()=0
virtual int	NumRenderElements ()=0
virtual IRenderElement *	GetRenderElement (int index)=0
virtual void	SetElementsActive (BOOL elementsActive)=0
virtual BOOL	GetElementsActive () const =0
virtual void	SetDisplayElements (BOOL displayElements)=0
virtual BOOL	GetDisplayElements () const =0
virtual void	SetCombustionOutputEnabled (BOOL combustionOutEnabled)=0
virtual BOOL	GetCombustionOutputEnabled () const =0
virtual void	SetCombustionOutput (const MaxSDK::AssetManagement::AssetUser &combustionOutputPath)=0
virtual const MaxSDK::AssetManagement::AssetUser &	GetCombustionOutput () const =0

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

fps_AddRenderElement	Search for all occurrences
fps_RemoveRenderElement	Search for all occurrences
fps_RemoveAllRenderElements	Search for all occurrences
fps_NumRenderElements	Search for all occurrences
fps_GetRenderElement	Search for all occurrences
fps_SetElementsActive	Search for all occurrences
fps_GetElementsActive	Search for all occurrences
fps_SetDisplayElements	Search for all occurrences
fps_GetDisplayElements	Search for all occurrences
fps_SetCombustionOutputEnabled	Search for all occurrences
fps_GetCombustionOutputEnabled	Search for all occurrences
fps_SetCombustionOutputPath	Search for all occurrences
fps_GetCombustionOutputPath	Search for all occurrences
fps_SetRenderElementFilename	Search for all occurrences
fps_GetRenderElementFilename	Search for all occurrences

    {
        fps_AddRenderElement, fps_RemoveRenderElement, fps_RemoveAllRenderElements,
        fps_NumRenderElements, fps_GetRenderElement,
        fps_SetElementsActive, fps_GetElementsActive,
        fps_SetDisplayElements, fps_GetDisplayElements,
        fps_SetCombustionOutputEnabled, fps_GetCombustionOutputEnabled,
        fps_SetCombustionOutputPath, fps_GetCombustionOutputPath,
        fps_SetRenderElementFilename, fps_GetRenderElementFilename,
    };

Member Function Documentation

virtual BOOL AppendMergedRenderElement ( IRenderElement * pRenderElement ) [pure virtual]

Search for all occurrences

Remarks:: This method gets called by the system to add a Render Element when it is merged from another file.

Parameters:: IRenderElement *pRenderElement

A pointer to the Render Element to add.

Returns:: TRUE if the merging was successful, FALSE if it was not.

virtual BOOL AppendMergedRenderElement ( ReferenceTarget * pRenderElement ) [pure virtual]

Search for all occurrences

Remarks:: This method gets called by the system to add a Render Element when it is merged from another file and ensures that the Reference Target is a Render Element.

Parameters:: ReferenceTarget *pRenderElement

A pointer to the Render Element to add.

Returns:: TRUE if the merging was successful, FALSE if it was not.

virtual BOOL AddRenderElement ( IRenderElement * pRenderElement ) [pure virtual]

Search for all occurrences

Remarks:: This method adds an IRenderElement instance to the manager's list.

Parameters:: IRenderElement *pRenderElement

A pointer to the Render Element to add.

Returns:: TRUE if the addition was successful, FALSE if it was not.

virtual BOOL AddRenderElement ( ReferenceTarget * pRenderElement ) [pure virtual]

Search for all occurrences

Remarks:: This method adds an IRenderElement instance to the manager's list and ensures that the Reference Target is a Render Element.

Parameters:: ReferenceTarget *pRenderElement

A pointer to the Render Element to add.

Returns:: TRUE if the addition was successful, FALSE if it was not.

virtual BOOL RemoveRenderElement ( IRenderElement * pRenderElement ) [pure virtual]

Search for all occurrences

virtual BOOL RemoveRenderElement ( ReferenceTarget * pRenderElement ) [pure virtual]

Search for all occurrences

Remarks:: This method removes an IRenderElement instance from the manager's list and ensures that the Reference Target is a Render Element.

Parameters:: ReferenceTarget *pRenderElement

A pointer to the Render Element to remove.

Returns:: TRUE if the addition was successful, FALSE if it was not.

virtual void RemoveAllRenderElements ( ) [pure virtual]

Search for all occurrences

Remarks:: This method will remove all the IRenderElement instances from the manager's list.

virtual int NumRenderElements ( ) [pure virtual]

Search for all occurrences

Remarks:: This method returns the number of Render Elements contained in the manager's list.

virtual IRenderElement* GetRenderElement ( int index ) [pure virtual]

Search for all occurrences

Remarks:: This method returns a pointer to a specific Render Element in manager's list.

Parameters:: int index

The index of the Render Element in the manager's list.

Returns:: A pointer to the specific Render Element or NULL if the index is invalid.

virtual void SetElementsActive ( BOOL elementsActive ) [pure virtual]

Search for all occurrences

Remarks:: This method sets whether the Render Elements List should be active during a render.

Parameters:: BOOL elementsActive

TRUE to activate the Render Elements List, FALSE to deactivate.

virtual BOOL GetElementsActive ( ) const [pure virtual]

Search for all occurrences

Remarks:: This method checks if the Render Elements List is active during a render and will return TRUE if it is or FALSE if it is not.

virtual void SetDisplayElements ( BOOL displayElements ) [pure virtual]

Search for all occurrences

Remarks:: This method sets whether the Render Elements should be displayed in their own (VFB) viewer window.

Parameters:: BOOL displayElements

TRUE to display in their own viewer, FALSE if you do not want to.

virtual BOOL GetDisplayElements ( ) const [pure virtual]

Search for all occurrences

Remarks:: This method checks whether the Render Elements are displayed in their own (VFB) viewer window and will return TRUE if they are or FALSE if they are not.

virtual void SetCombustionOutputEnabled ( BOOL combustionOutEnabled ) [pure virtual]

Search for all occurrences

Remarks:: This method sets whether the Render Element List should be exported to a Combustion format file.

Parameters:: BOOL combustionOutEnabled

TRUE to enable Combustion format file output.

virtual BOOL GetCombustionOutputEnabled ( ) const [pure virtual]

Search for all occurrences

Remarks:: This method checks whether the Render Element List will be exported to a Combustion format file and will return TRUE if they are or FALSE if they are not.

virtual void SetCombustionOutput ( const MaxSDK::AssetManagement::AssetUser & combustionOutputPath ) [pure virtual]

Search for all occurrences

Remarks:: This method allows you to set the output Asset for a Combustion format output file.

Parameters:: const MaxSDK::AssetManagement::AssetUser& combustionOutputPath

The AssetUser.

virtual const MaxSDK::AssetManagement::AssetUser& GetCombustionOutput ( ) const [pure virtual]

Search for all occurrences

Remarks:: This method returns the output Asset for a Combustion format file.

IRenderElementMgr Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation