Rm2DTextureVariable Class Reference

2D Texture Variable Node More...

#include <RmEffect.h>

Inheritance diagram for Rm2DTextureVariable:

List of all members.

Public Member Functions
	Rm2DTextureVariable ()
	Default constructor.
	Rm2DTextureVariable (const RM_TCHAR *strNodeName, const RM_TCHAR *strFileName=NULL)
	Constructor.
virtual	~Rm2DTextureVariable ()
	Destructor.
virtual RmNode *	Clone (bool bIncludeLoadedData)
	Clone this node.
virtual const RM_TCHAR *	GetDescription ()
virtual bool	IsNodeValid ()
	Is node valid.
virtual bool	LoadTexture ()
	Load texture.
virtual RmTexture *	GetTexture ()
	Get texture.
virtual const RmTexture *	GetTexture () const
	Get texture.
Rm2DTexture *	Get2DTexture ()
	Get texture.
const Rm2DTexture *	Get2DTexture () const
	Get texture.
Protected Member Functions
virtual void	SetType (const RM_TCHAR *strNewType)
	Set type string.

---

Detailed Description

2D Texture Variable Node

Rm2DTextureVariable is a node containing a 2D TEXTURE variable

---

Constructor & Destructor Documentation

Rm2DTextureVariable::Rm2DTextureVariable (   )

Default constructor. Default Constructor

Rm2DTextureVariable::Rm2DTextureVariable (  const RM_TCHAR *  strNodeName, const RM_TCHAR *  strFileName = NULL )

Constructor. Creates a new texture variable with specific name and file name reference (can be empty) Parameters: strNodeName  Node's name strFileName  Filename for Texture

virtual Rm2DTextureVariable::~Rm2DTextureVariable (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

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

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

const Rm2DTexture* Rm2DTextureVariable::Get2DTexture (   )  const [inline]

Get texture. Returns RenderMonkey 2D Texture Returns: Pointer to RenderMonkey 2D Texture See also: Rm2DTexture

Rm2DTexture* Rm2DTextureVariable::Get2DTexture (   )  [inline]

Get texture. Returns RenderMonkey 2D Texture Returns: Pointer to RenderMonkey 2D Texture See also: Rm2DTexture

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

virtual const RmTexture* Rm2DTextureVariable::GetTexture (   )  const [inline, virtual]

Get texture. Returns RenderMonkey Texture Returns: Pointer to RenderMonkey Texture See also: RmTexture Reimplemented from RmTextureVariable.

virtual RmTexture* Rm2DTextureVariable::GetTexture (   )  [inline, virtual]

Get texture. Returns RenderMonkey Texture Returns: Pointer to RenderMonkey Texture See also: RmTexture Reimplemented from RmTextureVariable.

virtual bool Rm2DTextureVariable::IsNodeValid (   )  [virtual]

Is node valid. Node valid property Returns: True if node is valid Reimplemented from RmTextureVariable. Reimplemented in RmRenderableTexture.

virtual bool Rm2DTextureVariable::LoadTexture (   )  [virtual]

Load texture. LoadTexture Returns: True on success, False otherwise Reimplemented from RmTextureVariable. Reimplemented in RmRenderableTexture.

virtual void Rm2DTextureVariable::SetType (  const RM_TCHAR *  strNewType  )  [inline, protected, virtual]

Set type string. Compose the type string chain Parameters: strNewType  New string Returns: Non Reimplemented from RmTextureVariable.

---

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

• RmEffect.h

---