RmEffectGroup Class Reference

Effect Group. More...

#include <RmEffect.h>

Inheritance diagram for RmEffectGroup:

List of all members.

Public Member Functions
	RmEffectGroup ()
	Default Constructor.
	RmEffectGroup (const RM_TCHAR *strGroupName)
	Constructor.
virtual	~RmEffectGroup ()
	Destructor.
virtual bool	IsArtistEditable ()
	Artist editable flag.
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 ()
RmEffect *	GetEffect (RmNode *pNode)
	Get Effect.
RmEffect *	GetEffect (const RM_TCHAR *strEffectName)
	Get effect.
RmEffect *	GetEffect (int nEffectIndex)
	Get effect.
int	GetEffectIndex (RmEffect *pEffect)
	Get effect index.
int	GetNumEffects ()
	Get number of effects.
RmEffectListIterator	BeginEffects ()
	Iterators for effects in this effect group.
RmEffectListConstIterator	BeginEffects () const
RmEffectListIterator	EndEffects ()
RmEffectListConstIterator	EndEffects () const
bool	AddEffect (RmEffect *pEffect)
	Add effect.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
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
RmEffectList	m_effectList
	List of pointers to the effect node children for this effect group.

---

Detailed Description

Effect Group.

RmEffectGroup structure contains any number of RmEffect structures

---

Constructor & Destructor Documentation

RmEffectGroup::RmEffectGroup (   )

Default Constructor. Constructor

RmEffectGroup::RmEffectGroup (  const RM_TCHAR *  strGroupName  )

Constructor. Create a new effect group with given name. Parameters: strGroupName  Nameof Node

virtual RmEffectGroup::~RmEffectGroup (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

bool RmEffectGroup::AddEffect (  RmEffect *  pEffect  )

Add effect. Adds the specified effect to this effect group Parameters: pEffect  Effect to add Returns: True on success

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

Clone this node. Creates a clone of this node Returns: Cloned node. Returns NULL if cloning failed. Reimplemented from RmNode.

virtual void RmEffectGroup::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.

virtual const RM_TCHAR* RmEffectGroup::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.

RmEffect* RmEffectGroup::GetEffect (  int  nEffectIndex  )

Get effect. Retrieve effect by its nIndex in this effect group Parameters: nEffectIndex  Index of effect Returns: Effect

RmEffect* RmEffectGroup::GetEffect (  const RM_TCHAR *  strEffectName  )

Get effect. Retrieve an effect node in this effect group by the name of the effect node Parameters: strEffectName  Name of effect to search Returns: Effect found

RmEffect* RmEffectGroup::GetEffect (  RmNode *  pNode  )

Get Effect. Retrieve effect node that the specified node belongs to Parameters: Node  See also: RmNode Returns: Effect See also: RmEffect

int RmEffectGroup::GetEffectIndex (  RmEffect *  pEffect  )

Get effect index. Retrieve the nIndex of the specified effect. Returns effect nIndex or -1 if effect doesn't belong to the group. Parameters: pEffect  See also: RmEffect

virtual RmNodeTypeChildRuleList* RmEffectGroup::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 RmEffectGroup::GetNumEffects (   )  [inline]

Get number of effects. Retrieve the number of effects in this effect group Returns: Number of effects

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

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

virtual bool RmEffectGroup::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.

virtual bool RmEffectGroup::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.

virtual void RmEffectGroup::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 RmEffectGroup::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

---