Class IRenderElementMgr
See Also: Class IRenderElement, Class FPMixinInterface, Class ReferenceTarget , Render Elements
class IRenderElementMgr : public FPMixinInterface
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.
Methods:
public:
Prototype:
virtual BOOL AppendMergedRenderElement(IRenderElement *pRenderElement)=0;
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.
Return Value:
TRUE if the merging was successful, FALSE if it was not.
Prototype:
virtual BOOL AppendMergedRenderElement(ReferenceTarget *pRenderElement)=0;
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.
Return Value:
TRUE if the merging was successful, FALSE if it was not.
Prototype:
virtual BOOL AddRenderElement(IRenderElement *pRenderElement)=0;
Remarks:
This method adds an IRenderElement instance to the manager’s list.
Parameters:
IRenderElement *pRenderElement
A pointer to the Render Element to add.
Return Value:
TRUE if the addition was successful, FALSE if it was not.
Prototype:
virtual BOOL AddRenderElement(ReferenceTarget *pRenderElement)=0;
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.
Return Value:
TRUE if the addition was successful, FALSE if it was not.
Prototype:
virtual BOOL RemoveRenderElement(ReferenceTarget *pRenderElement)=0;
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.
Return Value:
TRUE if the addition was successful, FALSE if it was not.
Prototype:
virtual void RemoveAllRenderElements()=0;
Remarks:
This method will remove all the IRenderElement instances from the manager’s list.
Prototype:
virtual int NumRenderElements()=0;
Remarks:
This method returns the number of Render Elements contained in the manager’s list.
Prototype:
virtual IRenderElement *GetRenderElement(int index)=0;
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.
Return Value:
A pointer to the specific Render Element or NULL if the index is invalid.
Prototype:
virtual void SetElementsActive(BOOL elementsActive)=0;
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.
Prototype:
virtual BOOL GetElementsActive() const = 0;
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.
Prototype:
virtual void SetDisplayElements(BOOL displayElements)=0;
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.
Prototype:
virtual BOOL GetDisplayElements() const = 0;
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.
Prototype:
virtual void SetCombustionOutputEnabled(BOOL combustionOutEnabled)=0;
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.
Prototype:
virtual BOOL GetCombustionOutputEnabled() const = 0;
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.
Prototype:
virtual void SetCombustionOutputPath(const TCHAR *combustionOutputPath)=0;
Remarks:
This method allows you to set the output path for a Combustion format output file.
Parameters:
const TCHAR *combustionOutputPath
The path string.
Prototype:
virtual void SetCombustionOutputPath(const TSTR& combustionOutputPath)=0;
Remarks:
This method allows you to set the output path for a Combustion format output file.
Parameters:
const TSTR& combustionOutputPath
The path string.
Prototype:
virtual const TSTR& GetCombustionOutputPath() const = 0;
Remarks:
This method returns the output path for a Combustion format file.
Prototype:
virtual const TCHAR* GetCombustionOutputPathPtr() const = 0;
Remarks:
This method returns the output path for a Combustion format file.