RmModelData Class Reference

ModelData. More...

#include <RmEffect.h>

Inheritance diagram for RmModelData:

List of all members.

Public Member Functions
	RmModelData ()
	Default Constructor.
	RmModelData (const RM_TCHAR *strName, const RM_TCHAR *strFileName)
	Constructor.
virtual	~RmModelData ()
	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	SetFileName (const RM_TCHAR *strFileName, bool bUpdateDatabase=true)
	Set filename.
const RmStringT &	GetFileName ()
	Get filename.
void	GetFullFileName (RM_TCHAR *strFullPath, int nSize)
	Get full filename.
bool	LoadModel ()
	Load model.
bool	CreateMeshModelContainer ()
	Create MeshModel container.
RmMeshModelContainer *	GetMeshContainer ()
	Get model container.
const RmMeshModelContainer *	GetMeshContainer () const
	Get model container.
void	SetOrientation (RmModelOrientation modelOrientation)
	Set Orientation.
RmModelOrientation	GetOrientation ()
	Get Orientation.
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
RmStringT	m_strFileName
	Name of the file that the model data points to.
RmMeshModelContainer *	m_pModelContainer
	Model Container RmMeshModelContainer.
bool	m_bModelLoaded
	Flag for if model is loaded.
RmModelOrientation	m_modelOrientation
	The model orientation.

---

Detailed Description

ModelData.

RmModelData structure stores the raw model data loaded by a RmModelPlugin this data is unprocessed and not renderable. RmModelData can be combined with a RmStreamMap to create a renderable RmModel

---

Constructor & Destructor Documentation

RmModelData::RmModelData (   )

Default Constructor. Default constructor

RmModelData::RmModelData (  const RM_TCHAR *  strName, const RM_TCHAR *  strFileName )

Constructor. Creates a new model data instance with a given name and given file name Parameters: strName  Name of node strFileName  Filename

virtual RmModelData::~RmModelData (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

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

bool RmModelData::CreateMeshModelContainer (   )

Create MeshModel container. Create ModelContainer Returns: True on success

virtual const RM_TCHAR* RmModelData::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.

const RmStringT& RmModelData::GetFileName (   )

Get filename. Retrieve file name Returns: Filename

void RmModelData::GetFullFileName (  RM_TCHAR *  strFullPath, int  nSize )

Get full filename. Retrieve full file name, corrected for RenderMonkey's relative paths, etc. Returns: Full file name

const RmMeshModelContainer* RmModelData::GetMeshContainer (   )  const [inline]

Get model container. Retrieve ModelContainer Returns: MeshContainer See also: RmMeshModelContainer

RmMeshModelContainer* RmModelData::GetMeshContainer (   )  [inline]

Get model container. Retrieve ModelContainer Returns: MeshContainer See also: RmMeshModelContainer

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

RmModelOrientation RmModelData::GetOrientation (   )  [inline]

Get Orientation. Gets the orientation of the model Returns: Model Orientation See also: RmModelOrientation

virtual bool RmModelData::IsNodeValid (   )  [virtual]

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

bool RmModelData::LoadModel (   )

Load model. LoadModel Returns: True on success

virtual bool RmModelData::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 RmModelData::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 RmModelData::SetFileName (  const RM_TCHAR *  strFileName, bool  bUpdateDatabase = true )

Set filename. Set model file name to the specified name Parameters: strFileName  Filename bUpdateDatabase  Flag to update the database Returns: None

virtual void RmModelData::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 RmModelData::SetOrientation (  RmModelOrientation  modelOrientation  )  [inline]

Set Orientation. Sets the orientation of the model Returns: None

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

---