RmState Class Reference

State. More...

#include <RmEffect.h>

Inheritance diagram for RmState:

List of all members.

Public Member Functions
	RmState ()
	Default Constructor.
	RmState (unsigned long ulStateType, unsigned long ulStateValue, RM_TCHAR *pStrUsage)
virtual	~RmState ()
	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 ()
unsigned long	GetStateType ()
	Get state type.
void	SetStateType (unsigned long ulType)
	Set type.
unsigned long	GetValue ()
	Get value.
void	SetValue (unsigned long nValue)
	Set value.
const RmStringT &	GetUsage ()
	Get usage string.
void	SetUsage (const RM_TCHAR *pStrUsage)
	Set usage string.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Copy node data.
Protected Attributes
unsigned long	m_ulState
	State identifier token, example: token equivalent to D3DRS_ALPHABLENDENABLE.
unsigned long	m_ulValue
	State value. Example: for the state id above, value = TRUE.
RmStringT	m_strUsage
	Used to specify whether this instance is a render state or a texture stage state.

---

Detailed Description

State.

RmState: a class for defining individual states - either render state, texture stage state or sampler state. This type of node is always hidden, and thus doesn't need a valid icon

---

Constructor & Destructor Documentation

RmState::RmState (   )  [inline]

Default Constructor. Default constructor

RmState::RmState (  unsigned long  ulStateType, unsigned long  ulStateValue, RM_TCHAR *  pStrUsage )  [inline]

Constructor Create a new state with given state type ID and state value Parameters: ulStateType  State type ulStateValue  State value pStrUsage  Usage name

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

Destructor. Destructor

---

Member Function Documentation

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

unsigned long RmState::GetStateType (   )  [inline]

Get state type. Retrieve state type token Returns: State type

const RmStringT& RmState::GetUsage (   )  [inline]

Get usage string. Retrieve this state's value Returns: Usage string

unsigned long RmState::GetValue (   )  [inline]

Get value. Retrieve this state's value Returns: State value

virtual bool RmState::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 RmState::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 RmState::SetStateType (  unsigned long  ulType  )  [inline]

Set type. Set this state's type token Parameters: ulType  Type to set Returns: None

void RmState::SetUsage (  const RM_TCHAR *  pStrUsage  )  [inline]

Set usage string. Set new value for this state Parameters: pStrUsage  New usage string Returns: None

void RmState::SetValue (  unsigned long  nValue  )  [inline]

Set value. Set new value for this state Parameters: nValue

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

---