RmCameraReference Class Reference

Camera Reference. More...

#include <RmEffect.h>

Inheritance diagram for RmCameraReference:

List of all members.

Public Member Functions
	RmCameraReference ()
	Default Constructor.
	RmCameraReference (const RM_TCHAR *strName)
	Constructor.
virtual	~RmCameraReference ()
	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.
void	SetReference (RmCamera *pRmCamera)
	Set reference.
bool	IsUseActiveCamera ()
	Flag to use active camera.
void	SetUseActiveCamera (bool bUseActiveCamera)
	Set to use active camera.
RmCamera *	GetReference ()
	Get reference.
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
RmCamera *	m_pCamera
	The camera node that this reference points to.
bool	m_bUseActiveCamera

---

Detailed Description

Camera Reference.

RmCameraReference for camera settings

---

Constructor & Destructor Documentation

RmCameraReference::RmCameraReference (   )

Default Constructor. Default constructor

RmCameraReference::RmCameraReference (  const RM_TCHAR *  strName  )

Constructor. Create a model reference node with specific name Parameters: strName  Name of Node

virtual RmCameraReference::~RmCameraReference (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

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

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

RmCamera* RmCameraReference::GetReference (   )  [inline]

Get reference. Retrieve RmCamera node that this node refers to Returns: Camera node See also: RmCamera

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

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

bool RmCameraReference::IsUseActiveCamera (   )  [inline]

Flag to use active camera. Flag to use active camera Returns: True if using active camera

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

virtual void RmCameraReference::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 RmCameraReference::SetReference (  RmCamera *  pRmCamera  )

Set reference. Set the pointer to referenced node ( RmCamera ) Parameters: pRmCamera  Camera node See also: RmCamera Returns: None

void RmCameraReference::SetUseActiveCamera (  bool  bUseActiveCamera  )

Set to use active camera. Specifies whether this camera reference will always use the active camera for the effect Parameters: bUseActiveCamera  Set true to use active camera Returns: None

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

---

Member Data Documentation

bool RmCameraReference::m_bUseActiveCamera [protected]

Flag specifying whether this reference will always point to the active camera in the effect

---

The documentation for this class was generated from the following file:

• RmEffect.h

---