RmBooleanVariable Class Reference

Boolean Variable Node. More...

#include <RmEffect.h>

Inheritance diagram for RmBooleanVariable:

List of all members.

Public Member Functions
	RmBooleanVariable ()
	Default Constructor.
	RmBooleanVariable (bool bValue)
	Constructor.
virtual	~RmBooleanVariable ()
	Destructor.
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	GetValue ()
	Get value.
void	SetValue (bool bValue)
	Set value.
void	SetValue (int nValue)
	Set value.
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
bool	m_bValue
	The boolean variable stored in the node.

---

Detailed Description

Boolean Variable Node.

RmBoolean is a node containing a BOOLEAN variable

---

Constructor & Destructor Documentation

RmBooleanVariable::RmBooleanVariable (   )

Default Constructor. Default constructor: creates a new boolean variable which is set to true

RmBooleanVariable::RmBooleanVariable (  bool  bValue  )

Constructor. Creates a new boolean variable with given value Parameters: bValue  Boolean value

virtual RmBooleanVariable::~RmBooleanVariable (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

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

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

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

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

bool RmBooleanVariable::GetValue (   )  [inline]

Get value. Returns the value stored in this boolean variable Returns: Boolean value of this node

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

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

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

void RmBooleanVariable::SetValue (  int  nValue  )  [inline]

Set value. Sets new value for the boolean Parameters: nVlaue  Non-zero value for True, zero for False Returns: None

void RmBooleanVariable::SetValue (  bool  bValue  )  [inline]

Set value. Sets new value for the boolean Parameters: bVlaue  True or False value Returns: None

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

---