RmRenderableTexture Class Reference

Renderable texture. More...

#include <RmEffect.h>

Inheritance diagram for RmRenderableTexture:

List of all members.

Public Member Functions
	RmRenderableTexture ()
	Default Constructor.
	RmRenderableTexture (const RM_TCHAR *strName, int nWidth, int nHeight, unsigned int unFormat, bool bUseViewportDims, bool bGenerateMipMaps)
	Constructor.
virtual	~RmRenderableTexture ()
	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.
virtual bool	LoadTexture ()
	Load texture.
int	GetWidth ()
	Get width.
void	SetWidth (int nWidth)
	Set width.
int	GetHeight ()
void	SetHeight (int nHeight)
	Set height.
float	GetWidthRatio ()
	Get width.
void	SetWidthRatio (float fWidthRatio)
	Set Width ratio.
float	GetHeightRatio ()
void	SetHeightRatio (float fHeightRatio)
	Set height ratio.
unsigned int	GetFormat ()
	Format.
void	SetFormat (unsigned int unFormat)
	Set format.
bool	UseViewportDimensions ()
	Use viewport dimensions.
void	SetUseViewportDimensions (bool bUse)
	Set use viewport dimensions.
bool	GenerateMipMaps ()
	Generate mipmaps.
void	SetGenerateMipMaps (bool bValue)
	Set generate mipmaps.
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
int	m_nWidth
	Width of the texture.
int	m_nHeight
	Height of the texture.
unsigned int	m_unFormat
	Texture format.
bool	m_bUseViewportDims
	Will this renderable texture use viewport dimensions for sizing.
float	m_fWidthRatio
	Width ratio of the texture when using viewport dimensions.
float	m_fHeightRatio
	Height ratio of the texture when using viewport dimensions.
bool	m_bGenerateMipMaps
	Will this renderable texture have automatically generated mip maps.
int	m_nHandle
	The handle to the run-time renderable surface.

---

Detailed Description

Renderable texture.

RmRenderableTexture structure defines parameters for a renderable texture

---

Constructor & Destructor Documentation

RmRenderableTexture::RmRenderableTexture (   )

Default Constructor. Default constructor

RmRenderableTexture::RmRenderableTexture (  const RM_TCHAR *  strName, int  nWidth, int  nHeight, unsigned int  unFormat, bool  bUseViewportDims, bool  bGenerateMipMaps )

Constructor. Create a new renderable texture with a given name and width/height parameters as well as a specified format and whether its size should be tied in to viewport dimensions. Parameters: strName  Name of node nWidth  Width of renderable texture nHeight  Height of renderable texture unFormat  Format for renderable texture bUseViewportDims  Flag to use Viewport dimension bGenerateMipMaps  Flag to generate Mipmaps

virtual RmRenderableTexture::~RmRenderableTexture (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

virtual RmNode* RmRenderableTexture::Clone (  bool  bIncludeLoadedData  )  [virtual]

Clone this node. Creates a clone of this node Returns: Cloned node. Returns NULL if cloning failed. Reimplemented from Rm2DTextureVariable.

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

bool RmRenderableTexture::GenerateMipMaps (   )  [inline]

Generate mipmaps. Does this renderable texture have automatically generated mip maps? Returns: Flag to generate mipmaps

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

unsigned int RmRenderableTexture::GetFormat (   )  [inline]

Format. Retrieve format of this renderable texture Returns: Format of renderable texture

int RmRenderableTexture::GetHandle (   )  [inline]

Get handle. Retrieve the handle for the run-time renderable surface used by the viewer Returns: Handle to texture

int RmRenderableTexture::GetHeight (   )  [inline]

Get height Retrieve height of this renderable texture Returns: Height of renderable texture

float RmRenderableTexture::GetHeightRatio (   )  [inline]

Get height Retrieve height of this renderable texture Returns: Height of renderable texture

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

int RmRenderableTexture::GetWidth (   )  [inline]

Get width. Retrieve width of this renderable texture Returns: Width of renderable texture

float RmRenderableTexture::GetWidthRatio (   )  [inline]

Get width. Retrieve width of this renderable texture Returns: Width of renderable texture

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

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

virtual bool RmRenderableTexture::LoadTexture (   )  [virtual]

Load texture. LoadTexture Returns: True on success Reimplemented from Rm2DTextureVariable.

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

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

void RmRenderableTexture::SetFormat (  unsigned int  unFormat  )  [inline]

Set format. Set format of this renderable texture Parameters: unFormat  Format

void RmRenderableTexture::SetGenerateMipMaps (  bool  bValue  )  [inline]

Set generate mipmaps. Set whether the renderable texture should automatically generate mip maps Parameters: Flag  to set generate mipmaps Returns: None

void RmRenderableTexture::SetHandle (  int  nHandle  )  [inline]

Set handle. Set the handle to the run-time renderable surface Parameters: nHandle  handle to texture Returns: None

void RmRenderableTexture::SetHeight (  int  nHeight  )  [inline]

Set height. Set height of this renderable texture Parameters: nHeight  Height of renderable texture Returns: None

void RmRenderableTexture::SetHeightRatio (  float  fHeightRatio  )  [inline]

Set height ratio. Set height ratio of this renderable texture Parameters: fHeightRatio  Height ratio of renderable texture Returns: None

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

void RmRenderableTexture::SetUseViewportDimensions (  bool  bUse  )  [inline]

Set use viewport dimensions. Set whether this renderable texture uses viewport dimensions at run-time Parameters: Flag  to use viewport dimensions None

void RmRenderableTexture::SetWidth (  int  nWidth  )  [inline]

Set width. Set the width of this renderable texture Parameters: nWidth  New width Returns: None

void RmRenderableTexture::SetWidthRatio (  float  fWidthRatio  )  [inline]

Set Width ratio. Set Width ratio of this renderable texture Parameters: fWidthRatio  Width ratio of renderable texture Returns: None

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

bool RmRenderableTexture::UseViewportDimensions (   )  [inline]

Use viewport dimensions. Does this renderable texture use viewport for its dimensions at run-time? Returns: Flag to use viewport width & height

---

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

• RmEffect.h

---