RmPlugInData Class Reference

Re PlugIn data. More...

#include <RmEffect.h>

Inheritance diagram for RmPlugInData:

List of all members.

Public Member Functions
	RmPlugInData ()
	Default Constructor.
	RmPlugInData (RM_TCHAR *pStrName, RmPlugInID plugInGUID)
	Constructor.
virtual void	Update (RmNodeUpdateType nodeUpdateType, RmNode *pRmUpdateRootNode)
	Update.
virtual RmNode *	Clone (bool bIncludeLoadedData)
	Clone this node.
virtual const RM_TCHAR *	GetDescription ()
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.
void	GetPlugInID (RmPlugInID &plugInID)
	Get plugin ID.
void	SetPlugInID (RmPlugInID plugInID)
	Set plugin ID.
bool	GetGeneratedFlag ()
	Get generated flag.
void	SetGeneratedFlag (bool bGenerated)
	Set generated flag.
void	SetTextDataBlock (const RM_TCHAR *strTextDataBlock)
	Set text block.
const RM_TCHAR *	GetTextDataBlock ()
	Text.
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
RmPlugInID	m_plugInID
	PlugIn ID.
RmStringT	m_strTextDataBlock
	Text block.
bool	m_bGenerated
	Generated flag.

---

Detailed Description

Re PlugIn data.

RmPlugInData for plug-in data storage .............///

---

Constructor & Destructor Documentation

RmPlugInData::RmPlugInData (   )

Default Constructor. Constructor

RmPlugInData::RmPlugInData (  RM_TCHAR *  pStrName, RmPlugInID  plugInGUID )

Constructor. Constructor: creates a plugInData node with an RmPlugInID Parameters: pStrName  Name of Node

---

Member Function Documentation

virtual RmNode* RmPlugInData::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 RmPlugInData::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* RmPlugInData::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.

bool RmPlugInData::GetGeneratedFlag (   )  [inline]

Get generated flag. Flag uf data is generated Returns: True if node is generated

virtual RmNodeTypeChildRuleList* RmPlugInData::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.

void RmPlugInData::GetPlugInID (  RmPlugInID &  plugInID  )  [inline]

Get plugin ID. Get RmPlugInID Parameters: plugInID  PlugIn ID Returns: None

const RM_TCHAR* RmPlugInData::GetTextDataBlock (   )  [inline]

Text. Get Text Data Block

virtual bool RmPlugInData::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 RmPlugInData::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 RmPlugInData::SetGeneratedFlag (  bool  bGenerated  )  [inline]

Set generated flag. Set flag if data is generated Parameters: True  if node is generated Returns: None

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

void RmPlugInData::SetPlugInID (  RmPlugInID  plugInID  )  [inline]

Set plugin ID. Set RmPlugInID Parameters: plugInID  PlugIn ID Returns: None

void RmPlugInData::SetTextDataBlock (  const RM_TCHAR *  strTextDataBlock  )  [inline]

Set text block. Parameters: strTextDataBlock  Text to set Returns: None

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

---