ShapeNode Class Reference
[Framework Module]

#include <shapenode.h>

Inheritance diagram for ShapeNode:

SceneNode Root Object TreeNode< Root > Referenced Counted Serialized List< Root > ListNode< Root >

List of all members.


Detailed Description

The ShapeNode is the base class of all objects which can be attached to a scene managed by the SceneServer class. A scene node object may provide transform or geometry information.

Public Member Functions

 ShapeNode (const char *id)
virtual ~ShapeNode ()
virtual bool LoadResources ()
virtual void UnloadResources ()
virtual void Render ()
virtual void CreateAnimators ()
void SetTextureFile (const string &textrure_file)
void SetOverlayFile (const string &overlay_file)
void SetOverlayColor (const vector3 &color)
void SetMeshFile (const string &mesh_file, vector2 *mapping, bool absolute)
TextureGetTexture ()
MeshGetMesh ()
void SetMappingAnimation (const string &mapping_file)
void SetCoordsAnimation (const string &coords_file)
void SetColorsAnimation (const string &colors_file)

Protected Member Functions

bool LoadTexture ()
bool LoadMesh ()
void UnloadTexture ()
void UnloadMesh ()

Protected Attributes

string texture_file
string overlay_file
string mesh_file
vector3 overlay_color
 Color used for overlay image.
Ref< Texturetexture
Ref< Meshmesh
vector2mapping
bool absolute
 Whether mapping coordinates are absolute [0..size] or relative [0..1].
string mapping_file
string coords_file
string colors_file
vector2mapping_buff
 Buffer for animated mapping.
vector2coords_buff
 Buffer for animated coords.
vector4colors_buff
 Buffer for animated colors.

Constructor & Destructor Documentation

ShapeNode::ShapeNode ( const char *  id  ) 

Constructor.

ShapeNode::~ShapeNode (  )  [virtual]

Destructor.


Member Function Documentation

bool ShapeNode::LoadResources (  )  [virtual]

This method makes sure that all resources needed by this object are loaded. The method does NOT recurse into its children.

Returns:
True, if resource loading was successful.

Reimplemented from SceneNode.

void ShapeNode::UnloadResources (  )  [virtual]

This method makes sure that all resources used by this object are unloaded. The method does NOT recurse into its children.

Returns:
True, if resources have actually been unloaded.

Reimplemented from SceneNode.

void ShapeNode::Render (  )  [virtual]

Perform per-instance rendering of geometry. This method will be called once for each instance of the node.

Reimplemented from SceneNode.

void ShapeNode::CreateAnimators (  )  [virtual]

Creates all assigned animators and animation buffers for this shape node and all children. Animators are created only if mesh is valid and it has nonzero amount of vertices.

Reimplemented from SceneNode.

void ShapeNode::SetTextureFile ( const string &  textrure_file  ) 

void ShapeNode::SetOverlayFile ( const string &  overlay_file  ) 

void ShapeNode::SetOverlayColor ( const vector3 color  )  [inline]

void ShapeNode::SetMeshFile ( const string &  mesh_file,
vector2 mapping,
bool  absolute 
)

Texture * ShapeNode::GetTexture (  )  [inline]

Mesh * ShapeNode::GetMesh (  )  [inline]

void ShapeNode::SetMappingAnimation ( const string &  mapping_file  ) 

void ShapeNode::SetCoordsAnimation ( const string &  coords_file  ) 

void ShapeNode::SetColorsAnimation ( const string &  colors_file  ) 

bool ShapeNode::LoadTexture (  )  [protected]

bool ShapeNode::LoadMesh (  )  [protected]

void ShapeNode::UnloadTexture (  )  [protected]

void ShapeNode::UnloadMesh (  )  [protected]


Member Data Documentation

string ShapeNode::texture_file [protected]

string ShapeNode::overlay_file [protected]

string ShapeNode::mesh_file [protected]

vector3 ShapeNode::overlay_color [protected]

Color used for overlay image.

Ref<Texture> ShapeNode::texture [protected]

Ref<Mesh> ShapeNode::mesh [protected]

vector2* ShapeNode::mapping [protected]

bool ShapeNode::absolute [protected]

Whether mapping coordinates are absolute [0..size] or relative [0..1].

string ShapeNode::mapping_file [protected]

string ShapeNode::coords_file [protected]

string ShapeNode::colors_file [protected]

vector2* ShapeNode::mapping_buff [protected]

Buffer for animated mapping.

vector2* ShapeNode::coords_buff [protected]

Buffer for animated coords.

vector4* ShapeNode::colors_buff [protected]

Buffer for animated colors.


The documentation for this class was generated from the following files:
Generated on Sat Oct 20 14:47:36 2007 for Dark Oberon by  doxygen 1.5.3