RmLightObject Class Reference

Light Object. More...

#include <RmEffect.h>

Inheritance diagram for RmLightObject:

List of all members.

Public Member Functions
	RmLightObject ()
	Public member functions Default Constructor.
	RmLightObject (int nStageIndex, const RM_TCHAR *pStrAPI)
	Constructor.
virtual	~RmLightObject ()
	Destructor.
void	Initialize ()
	Initialization.
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	AddLightReference (RmLightReference *pLightReference)
	Add light.
void	DeleteLightReference ()
	Delete light reference.
RmLightReference *	LightReference ()
	Get light 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
	Light nIndex for this light object.
RmLightReference *	m_pLightReference
	Light reference attached to this light object.

---

Detailed Description

Light Object.

RmLightObject contains an nIndex and a RmLightReference child

---

Constructor & Destructor Documentation

RmLightObject::RmLightObject (   )

Public member functions Default Constructor. Default constructor

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

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

virtual RmLightObject::~RmLightObject (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

bool RmLightObject::AddLightReference (  RmLightReference *  pLightReference  )

Add light. Adds a light reference node to this light object. Light reference actually links this light object to a specific light variable. Parameters: pLightReference  Light reference See also: RmLightReference Returns: True on success

virtual RmNode* RmLightObject::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 RmLightObject::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 RmLightObject::DeleteLightReference (   )

Delete light 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* RmLightObject::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 RmLightObject::GetIndex (   )  [inline]

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

virtual RmNodeTypeChildRuleList* RmLightObject::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 RmLightObject::Initialize (   )

Initialization. Initializes texture object Returns: None

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

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

RmLightReference* RmLightObject::LightReference (   )  [inline]

Get light reference. Retrieve texture reference node from this texture object Returns: Light reference See also: RmLightReference

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

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

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

---