RmTextureReference Class Reference

Texture reference. More...

#include <RmEffect.h>

Inheritance diagram for RmTextureReference:

List of all members.

Public Member Functions
	RmTextureReference ()
	Default Constructor.
	RmTextureReference (const RM_TCHAR *strTextureName)
	Constructor.
virtual	~RmTextureReference ()
	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 ()
virtual bool	IsNodeValid ()
	Is node valid.
RmNode *	GetReference ()
	Get reference.
void	SetReference (RmNode *pTextureVariable)
	Set reference.
int	GetHandle ()
	Get handle.
void	SetHandle (int nHandle)
	Set handle.
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
RmNode *	m_pTextureNode
	The texture variable that this texture references to.
int	m_nHandle
	The handle for viewer-managed texture resource associated with texture reference.

---

Detailed Description

Texture reference.

RmTexture structure specifies the name and compression of a texture it also contains any number of texture stage states

---

Constructor & Destructor Documentation

RmTextureReference::RmTextureReference (   )

Default Constructor. Default constructor

RmTextureReference::RmTextureReference (  const RM_TCHAR *  strTextureName  )

Constructor. Creates texture reference with a given name that points to the texture variable name this node references Parameters: strTextureName  Name of Node

virtual RmTextureReference::~RmTextureReference (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

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

int RmTextureReference::GetHandle (   )  [inline]

Get handle. Retrieve resource handle for this texture reference return Handle to texture

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

RmNode* RmTextureReference::GetReference (   )  [inline]

Get reference. Retrieve the node this texture reference refers to Returns: Texture Node See also: RmNode

virtual bool RmTextureReference::IsNodeValid (   )  [virtual]

Is node valid. Node valid property Returns: True if node is valid Reimplemented from RmNode.

virtual bool RmTextureReference::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 RmTextureReference::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 RmTextureReference::SetHandle (  int  nHandle  )  [inline]

Set handle. Store texture handle for the reference Returns: nHandle Handle to texture None

virtual void RmTextureReference::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 RmTextureReference::SetReference (  RmNode *  pTextureVariable  )

Set reference. Set texture reference node for this object Parameters: pTextureVariable  Texture node to reference to Returns: None

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

---