RmEffect Class Reference

Effect. More...

#include <RmEffect.h>

Inheritance diagram for RmEffect:

List of all members.

Public Member Functions
	RmEffect ()
	Default Constructor.
virtual	~RmEffect ()
	Destructor.
virtual bool	IsArtistEditable ()
	Artist editable flag.
virtual bool	AddChild (RmNode *pChildNode, RmNode *pNextSibling=NULL)
	Add child.
virtual void	Update (RmNodeUpdateType nodeUpdateType, RmNode *pRmUpdateRootNode)
	Update.
virtual bool	LoadXMLData (int hDoc, const RM_TCHAR *strXPath, const RM_TCHAR *strRmXMLVersion)
	Load node data from XML.
virtual bool	SaveXMLData (int hDoc, const RM_TCHAR *strXPath)
	Save node data to XML.
virtual RmNode *	Clone (bool bIncludeLoadedData)
	Clone this node.
virtual const RM_TCHAR *	GetDescription ()
bool	AddPass (RmPass *pPass)
	Add Pass.
void	Initialize ()
	Initialize.
RmPass *	GetPass (const RM_TCHAR *strPassName)
	Get pass.
RmPass *	GetPass (RmNode *pNode)
	Get pass.
RmPass *	GetPass (int nPassIndex)
	Get pass.
int	GetNumPasses ()
int	GetNumEnabledPasses ()
RmCamera *	GetActiveCamera ()
	Get active camera.
void	SetActiveCamera (RmCamera *pRmCamera)
	Set active camera.
void	ReOrderPassIndices ()
	Reoder passes.
RmPassListIterator	BeginPasses ()
	Iterators for passes.
RmPassListConstIterator	BeginPasses () const
RmPassListIterator	EndPasses ()
RmPassListConstIterator	EndPasses () const
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
virtual void	SetType (const RM_TCHAR *strNewType)
	Set type.
virtual RmNodeTypeChildRuleList *	GetNodeTypeChildRuleList ()
	Parent / Child rule list function.
virtual void	SetNodeTypeChildRuleList (RmNodeTypeChildRuleList *pRmNodeChildRuleList)
	Sets the node child rule list for the given node.
Protected Attributes
RmPassList	m_passList
	A list of all passes that belong to the given effect node.
RmCamera *	m_pActiveCamera
	Active Camera pointer.
RmStringT	m_strActiveCamera
	Active Camera Name.

---

Detailed Description

Effect.

RmEffect structure contains any number of RmPass structures

---

Constructor & Destructor Documentation

RmEffect::RmEffect (   )

Default Constructor. Constructor

virtual RmEffect::~RmEffect (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

virtual bool RmEffect::AddChild (  RmNode *  pChildNode, RmNode *  pNextSibling = NULL )  [virtual]

Add child. Add a new child node Parameters: pChildNode  Child node pNextSibling  If not NULL, child gets inserted before this node Returns: True on Success Reimplemented from RmNode.

bool RmEffect::AddPass (  RmPass *  pPass  )

Add Pass. Adds a new pass to the effect node Parameters: pPass  Pass to add See also: RmPass Returns: True on success

virtual RmNode* RmEffect::Clone (  bool  bIncludeLoadedData  )  [virtual]

Clone this node. Creates a clone of this node Returns: Cloned node. Returns NULL if cloning failed. Reimplemented from RmNode. Reimplemented in RmOpenGLEffect, and RmDirectXEffect.

virtual void RmEffect::CopyNodeData (  RmNode *  pDestinationNode, bool  bIncludeLoadedData )  [protected, virtual]

Copy node data. Copies this node's contents (not including children) into the destination node. See RmNode::CopyNodeData for details Parameters: pDestinationNode  the destination node Returns: None Reimplemented from RmNode.

RmCamera* RmEffect::GetActiveCamera (   )  [inline]

Get active camera. Retrieve camera data from the pass. Returns: Active camera See also: RmCamera

virtual const RM_TCHAR* RmEffect::GetDescription (   )  [virtual]

Returns description of the node: used for displaying a tooltip in the workspace tree view for the given node. Returns: Returns description string Reimplemented from RmNode.

virtual RmNodeTypeChildRuleList* RmEffect::GetNodeTypeChildRuleList (   )  [inline, protected, virtual]

Parent / Child rule list function. Retrieves the rule list for adding child nodes for a given node type Returns: Returns node type child list rules Reimplemented from RmNode.

int RmEffect::GetNumEnabledPasses (   )

Return the number of enabled passes in this effect group Returns: Number of enabled passes

int RmEffect::GetNumPasses (   )  [inline]

Return the number of passes in this effect group Returns: Number of passes

RmPass* RmEffect::GetPass (  int  nPassIndex  )

Get pass. Retrieve a pass by its nIndex in this effect node Parameters: nPassIndex  Indx to pass Returns: Pass See also: RmPass

RmPass* RmEffect::GetPass (  RmNode *  pNode  )

Get pass. Retrieves a pass that owns a given node Parameters: pNode  See also: RmNode Returns: Pass See also: RmPass

RmPass* RmEffect::GetPass (  const RM_TCHAR *  strPassName  )

Get pass. Retrieves a pass by its name Parameters: strPassName  pass name to search for Returns: Found pass See also: RmPass

void RmEffect::Initialize (   )

Initialize. Initializes the effect node to have a single pass Returns: None

virtual bool RmEffect::IsArtistEditable (   )  [inline, virtual]

Artist editable flag. Artist-editable property Returns: True Reimplemented from RmNode.

virtual bool RmEffect::LoadXMLData (  int  hDoc, const RM_TCHAR *  strXPath, const RM_TCHAR *  strRmXMLVersion )  [virtual]

Load node data from XML. Loads versioned XML node data. Note that this method will only load the contents of each node, not the data for all of the children nodes. Each child will have its own XML loading function called by the API. Parameters: hDoc  Handle to the XML document strXPath  Node path in XML strRmXMLVersion  XML version Returns: True if load succeeded. False otherwise. Reimplemented from RmNode.

void RmEffect::ReOrderPassIndices (   )

Reoder passes. Function to reorder the pass indices. Returns: None

virtual bool RmEffect::SaveXMLData (  int  hDoc, const RM_TCHAR *  strXPath )  [virtual]

Save node data to XML. Saves node's contents to XML. Note that this method will only save the contents of each node, not the data for all of the children nodes. Each child will have its own XML saving function called by the API. Parameters: hDoc  Handle to the XML document strXPath  Node path in XML Returns: True if save succeeded. False otherwise. Reimplemented from RmNode.

void RmEffect::SetActiveCamera (  RmCamera *  pRmCamera  )

Set active camera. Set active camera Parameters: pRmCamera  Camera to set active Returns: None

virtual void RmEffect::SetNodeTypeChildRuleList (  RmNodeTypeChildRuleList *  pRmNodeChildRuleList  )  [inline, protected, virtual]

Sets the node child rule list for the given node. Sets the child addition rule list for the given node. Parameters: pRmNodeChildRuleList  new node rules list None  Reimplemented from RmNode.

virtual void RmEffect::SetType (  const RM_TCHAR *  strNewType  )  [inline, protected, virtual]

Set type. Compose the type string chain Parameters: strNewType  New type string Returns: None Reimplemented from RmNode.

virtual void RmEffect::Update (  RmNodeUpdateType  nodeUpdateType, RmNode *  pRmUpdateRootNode )  [virtual]

Update. Updates the internal values of the node Parameters: nodeUpdateType  Update type See also: RmNodeUpdateType Parameters: pRmUpdateRootNode  Root node for update Returns: None Reimplemented from RmNode.

---

The documentation for this class was generated from the following file:

• RmEffect.h

---