Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

Rm3DTextureVariable Class Reference

3D Texture Variable Node More...

#include <RmEffect.h>

Inheritance diagram for Rm3DTextureVariable:

RmTextureVariable RmVariable RmNode List of all members.

Public Member Functions

 Rm3DTextureVariable ()
 Default constructor.

 Rm3DTextureVariable (const RM_TCHAR *strNodeName, const RM_TCHAR *strFileName=NULL)
 Constructor.

virtual ~Rm3DTextureVariable ()
 Destructor.

virtual RmNodeClone (bool bIncludeLoadedData)
 Clone this node.

virtual const RM_TCHAR * GetDescription ()
virtual bool IsNodeValid ()
 Is node valid.

virtual bool LoadTexture ()
 Load texture.

virtual RmTextureGetTexture ()
 Get texture.

virtual const RmTextureGetTexture () const
 Get texture.

Rm3DTextureGet3DTexture ()
 Get texture.

const Rm3DTextureGet3DTexture () const
 Get texture.


Detailed Description

3D Texture Variable Node

Rm3DTextureVariable is a node containing a VOLUME TEXTURE variable


Constructor & Destructor Documentation

Rm3DTextureVariable::Rm3DTextureVariable  ) 
 

Default constructor.

Default Constructor

Rm3DTextureVariable::Rm3DTextureVariable const RM_TCHAR *  strNodeName,
const RM_TCHAR *  strFileName = NULL
 

Constructor.

Creates a new volume texture variable with specific name and file name reference (can be empty)

Parameters:
strNodeName Node's name
strFileName Filename

virtual Rm3DTextureVariable::~Rm3DTextureVariable  )  [virtual]
 

Destructor.

Destructor


Member Function Documentation

virtual RmNode* Rm3DTextureVariable::Clone bool  bIncludeLoadedData  )  [virtual]
 

Clone this node.

Creates a clone of this node

Returns:
Cloned node. Returns NULL if cloning failed.

Reimplemented from RmTextureVariable.

const Rm3DTexture* Rm3DTextureVariable::Get3DTexture  )  const [inline]
 

Get texture.

Returns RenderMonkey 3D Texture

Returns:
Pointer to RenderMonkey 3D Texture
See also:
Rm3DTexture

Rm3DTexture* Rm3DTextureVariable::Get3DTexture  )  [inline]
 

Get texture.

Returns RenderMonkey 3D Texture

Returns:
Pointer to RenderMonkey 3D Texture
See also:
Rm3DTexture

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

virtual const RmTexture* Rm3DTextureVariable::GetTexture  )  const [inline, virtual]
 

Get texture.

Returns RenderMonkey Texture

Returns:
Pointer to RenderMonkey Texture
See also:
RmTexture

Reimplemented from RmTextureVariable.

virtual RmTexture* Rm3DTextureVariable::GetTexture  )  [inline, virtual]
 

Get texture.

Returns RenderMonkey Texture

Returns:
Pointer to RenderMonkey Texture
See also:
RmTexture

Reimplemented from RmTextureVariable.

virtual bool Rm3DTextureVariable::IsNodeValid  )  [virtual]
 

Is node valid.

Node valid property

Returns:
True if node is valid

Reimplemented from RmTextureVariable.

virtual bool Rm3DTextureVariable::LoadTexture  )  [virtual]
 

Load texture.

LoadTexture

Returns:
True on success, False otherwise

Reimplemented from RmTextureVariable.


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:08:52 2005 for RenderMonkey SDK by doxygen 1.3.6