RmIntegerVariable Class Reference

Integer Variable Node. More...

#include <RmEffect.h>

Inheritance diagram for RmIntegerVariable:

List of all members.

Public Member Functions
	RmIntegerVariable ()
	Default Constructor.
	RmIntegerVariable (int nValue)
	Constructor.
	RmIntegerVariable (int nValue, bool bClamp, int nMin, int nMax)
	Constructor.
virtual	~RmIntegerVariable ()
	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 ()
int	GetValue ()
	Get value.
void	SetValue (int nValue)
	Set value.
bool	IsClamped ()
	Clamp flag.
void	SetIsClamped (bool bClamp)
	Set clamp flag.
int	GetMin ()
	Get min.
int	GetMax ()
	Get max.
void	SetMin (int nMin)
	Set min.
void	SetMax (int nMax)
	Set max.
void	SetMinMax (int nMin, int nMax)
	Set min & max.
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
int	m_nValue
	The integer value stored in this node.
int	m_nMin
	The min and max bounds for this variable.
int	m_nMax
bool	m_bClamp
	Will this variable be clamped?

---

Detailed Description

Integer Variable Node.

RmInteger is a single SCALAR INTEGER value

---

Constructor & Destructor Documentation

RmIntegerVariable::RmIntegerVariable (   )

Default Constructor. Default constructor: creates a new integer variable with value = 0, not clamped (although clamping range is set to be [-10, 10] by default )

RmIntegerVariable::RmIntegerVariable (  int  nValue  )

Constructor. Creates an integer node with a given value, not clamped (although clamping range is set to be [-10, 10] by default ) Parameters: nValue  Value to initialize

RmIntegerVariable::RmIntegerVariable (  int  nValue, bool  bClamp, int  nMin, int  nMax )

Constructor. Creates a new integer node with a given value, clamping range and specifies whether it is supposed to be automatically clamped to the range. Parameters: nValue  Value to initialize bClamp  Clamping flag nMin  Min Value nMax  Max Value

virtual RmIntegerVariable::~RmIntegerVariable (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

virtual RmNode* RmIntegerVariable::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 RmIntegerVariable::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* RmIntegerVariable::GetDescription (   )  [virtual]

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

int RmIntegerVariable::GetMax (   )  [inline]

Get max. Specify the upper bound for clamping Returns: Max value

int RmIntegerVariable::GetMin (   )  [inline]

Get min. Specify the lower bound for clamping Returns: Min value

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

int RmIntegerVariable::GetValue (   )  [inline]

Get value. Retrieve the value of this integer node Returns: Value

bool RmIntegerVariable::IsClamped (   )  [inline]

Clamp flag. Retrieve whether the variable is clamped Returns: Clamping flag

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

void RmIntegerVariable::SetIsClamped (  bool  bClamp  )  [inline]

Set clamp flag. Set whether this variable is clamped Parameters: bClamp  Clamp flag Returns: None

void RmIntegerVariable::SetMax (  int  nMax  )

Set max. Set the upper bound for clamping Parameters: nMax  Max value Returns: None

void RmIntegerVariable::SetMin (  int  nMin  )

Set min. Set the lower bound for clamping Parameters: nMin  Min value Returns: None

void RmIntegerVariable::SetMinMax (  int  nMin, int  nMax )

Set min & max. Set the clamping bounds Parameters: nMin  Min value nMax  Max value Returns: None

virtual void RmIntegerVariable::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 RmIntegerVariable::SetValue (  int  nValue  )

Set value. Set the value for this integer node Parameters: nValue  Value to set Returns: None

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

---