RmMaterialObject Class Reference

Material Object. More...

#include <RmEffect.h>

Inheritance diagram for RmMaterialObject:

List of all members.

Public Member Functions
	RmMaterialObject ()
	Public member functions Default Constructor.
	RmMaterialObject (int nStageIndex, const RM_TCHAR *pStrAPI)
	Constructor.
virtual	~RmMaterialObject ()
	Destructor.
void	Initialize ()
	Initialize.
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.
bool	AddMaterialReference (RmMaterialReference *pMaterialReference)
	Add material reference.
void	DeleteMaterialReference ()
	Delete material reference.
RmMaterialReference *	MaterialReference ()
	Get material reference.
int	GetIndex ()
	Get index.
void	SetIndex (int nIndex)
	Set index.
Protected Member Functions
virtual void	CopyNodeData (RmNode *pDestinationNode, bool bIncludeLoadedData)
	Protected member functions 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_nIndex
	Material nIndex for this light object.
RmMaterialReference *	m_pMaterialReference
	Material reference attached to this light object.

---

Detailed Description

Material Object.

RmMaterialObject contains an nIndex and a RmMaterialReference child ..........///

---

Constructor & Destructor Documentation

RmMaterialObject::RmMaterialObject (   )

Public member functions Default Constructor. Default constructor

RmMaterialObject::RmMaterialObject (  int  nStageIndex, const RM_TCHAR *  pStrAPI )

Constructor. Create new light object for given light nIndex Parameters: nStageIndex  Stage index pStrAPI  API String

virtual RmMaterialObject::~RmMaterialObject (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

bool RmMaterialObject::AddMaterialReference (  RmMaterialReference *  pMaterialReference  )

Add material reference. Adds a light reference node to this light object. Material reference actually links this light object to a specific light variable. Parameters: pMaterialReference  Material reference See also: RmMaterialReference Returns: True on success

virtual RmNode* RmMaterialObject::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 RmMaterialObject::CopyNodeData (  RmNode *  pDestinationNode, bool  bIncludeLoadedData )  [protected, virtual]

Protected member functions 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.

void RmMaterialObject::DeleteMaterialReference (   )

Delete material reference. Deletes current light reference from this light object. Note that this call will actually delete the light node itself. Returns: None

virtual const RM_TCHAR* RmMaterialObject::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 RmMaterialObject::GetIndex (   )  [inline]

Get index. Retrieve texture stage nIndex for this texture object Returns: Index

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

void RmMaterialObject::Initialize (   )

Initialize. Initializes texture object Returns: None

virtual bool RmMaterialObject::IsNodeValid (   )  [inline, virtual]

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

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

RmMaterialReference* RmMaterialObject::MaterialReference (   )  [inline]

Get material reference. Retrieve texture reference node from this texture object Returns: Materual reference See also: RmMaterialReference

virtual bool RmMaterialObject::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 RmMaterialObject::SetIndex (  int  nIndex  )  [inline]

Set index. Set texture stage nIndex for this texture object Parameters: nIndex  Index Returns: None

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

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

---