RmVariable Class Reference

Variable node. More...

#include <RmEffect.h>

Inheritance diagram for RmVariable:

List of all members.

Public Member Functions
	RmVariable ()
	Default constructor.
virtual	~RmVariable ()
	Destructor.
virtual bool	IsArtistEditable ()
	Returns whether this variable is artist editable or not.
void	SetIsArtistEditable (bool bValue)
	Set whether this variable is artist-editable or not.
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 const RM_TCHAR *	GetVariableSemantic ()
	Get variable semantic attribute.
virtual void	SetVariableSemantic (const RM_TCHAR *pStrVariableSemantic)
	Set variable semantic.
virtual bool	IsPredefinedVariable ()
	Retrieve whether this variable is a RenderMonkey predefined variable.
virtual bool	IsPrelinkedVariable ()
	Retrieve whether this variable is a RenderMonkey prelinked variable.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
virtual void	SetType (const RM_TCHAR *strNewType)
	Set node type.
virtual RmNodeTypeChildRuleList *	GetNodeTypeChildRuleList ()
	Get node child rule.
virtual void	SetNodeTypeChildRuleList (RmNodeTypeChildRuleList *pRmNodeChildRuleList)
	Sets the node child rule list for the given node.
Protected Attributes
bool	m_bArtistVar
	A flag denoting whether a variable is artist-editable or not.
RmStringT	m_strVariableSemantic

---

Detailed Description

Variable node.

A generic variable class. Stores whether a given variable is artist-editable or not

---

Constructor & Destructor Documentation

RmVariable::RmVariable (   )  [inline]

Default constructor. Default constructor

virtual RmVariable::~RmVariable (   )  [inline, virtual]

Destructor. Destructor

---

Member Function Documentation

virtual void RmVariable::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. Reimplemented in RmDynamicVariable, RmLightVariable, RmMaterialVariable, RmVectorVariable, RmMatrixVariable, RmFloatVariable, RmIntegerVariable, RmStringVariable, RmBooleanVariable, RmTextureVariable, RmColorVariable, and RmRenderableTexture.

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

Get node child rule. Parent / Child rule list function Returns: Returns node child rule Reimplemented from RmNode. Reimplemented in RmDynamicVariable, RmLightVariable, RmMaterialVariable, RmVectorVariable, RmMatrixVariable, RmFloatVariable, RmIntegerVariable, RmStringVariable, RmBooleanVariable, RmTextureVariable, RmColorVariable, and RmRenderableTexture.

virtual const RM_TCHAR* RmVariable::GetVariableSemantic (   )  [inline, virtual]

Get variable semantic attribute. Get variable semantic attribute Returns: Semantic string

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

Returns whether this variable is artist editable or not. Returns whether this variable is artist editable or not Returns: True if this variable is artist editable Reimplemented from RmNode.

virtual bool RmVariable::IsPredefinedVariable (   )  [virtual]

Retrieve whether this variable is a RenderMonkey predefined variable. Retrieve whether this variable is a RenderMonkey predefined variable (See RenderMonkey documentation for more details about predefined variables) Returns: True if this variable is predefined variable

virtual bool RmVariable::IsPrelinkedVariable (   )  [virtual]

Retrieve whether this variable is a RenderMonkey prelinked variable. Retrieve whether this variable is a RenderMonkey prelinked variable (See RenderMonkey documentation for more details about prelinked variables) Returns: True if this variable is prelinked variable

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

Load node data from XML. Loading versioned XML node data. Parameters: hDoc  Handle to XML document strXPath  Node path in XML strRmXMLVersion  XML version Returns: True if load succeeded. False otherwise. Reimplemented from RmNode. Reimplemented in RmDynamicVariable, RmLightVariable, RmMaterialVariable, RmVectorVariable, RmMatrixVariable, RmFloatVariable, RmIntegerVariable, RmStringVariable, RmBooleanVariable, RmTextureVariable, RmColorVariable, and RmRenderableTexture.

virtual bool RmVariable::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. Reimplemented in RmDynamicVariable, RmLightVariable, RmMaterialVariable, RmVectorVariable, RmMatrixVariable, RmFloatVariable, RmIntegerVariable, RmStringVariable, RmBooleanVariable, RmTextureVariable, RmColorVariable, and RmRenderableTexture.

void RmVariable::SetIsArtistEditable (  bool  bValue  )  [inline]

Set whether this variable is artist-editable or not. Set whether this variable is artist-editable or not Parameters: bValue  Flag to specify if this is artist editable None

virtual void RmVariable::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. Reimplemented in RmDynamicVariable, RmLightVariable, RmMaterialVariable, RmVectorVariable, RmMatrixVariable, RmFloatVariable, RmIntegerVariable, RmStringVariable, RmBooleanVariable, RmTextureVariable, RmColorVariable, and RmRenderableTexture.

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

Set node type. Compose the type string chain Parameters: strNewType  New type string Returns: None Reimplemented from RmNode. Reimplemented in RmTextureVariable, and Rm2DTextureVariable.

virtual void RmVariable::SetVariableSemantic (  const RM_TCHAR *  pStrVariableSemantic  )  [inline, virtual]

Set variable semantic. Set variable semantic attribute Parameters: pStrVariableSemantic  Sematic string Returns: None

---

Member Data Documentation

RmStringT RmVariable::m_strVariableSemantic [protected]

Indicates the semantic of the variable. Used to indicate a predefined variables usage.

---

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

• RmEffect.h

---