SceneObject Class Reference
[Framework Module]

#include <sceneobject.h>

Inheritance diagram for SceneObject:

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

List of all members.

Public Types

typedef void(* RenderCallbackFun )(void *)

Public Member Functions

 SceneObject (const char *id)
virtual ~SceneObject ()
byte_t AddModel (const string &model_file)
bool ActivateModel (byte_t id)
ModelGetActiveModel () const
void SetOverlayColor (const vector3 &color)
void SetPosition (const vector3 &position)
void SetSize (const vector2 &size)
const vector3GetPosition () const
const vector2GetSize () const
void SetVisible (bool visible)
bool IsVisible () const
void SetRenderCallbacks (RenderCallbackFun render_begin, RenderCallbackFun render_end)
bool LoadResources ()
bool IsResourcesValid () const
void UpdateAnimators ()
void PauseAnimators ()
void Render (bool callbacks=true) const

Protected Types

typedef vector
< ModelItem * > 
ModelsArray

Protected Member Functions

void UnloadResources ()

Protected Attributes

vector3 position
 Position of the object.
vector2 size
 Width and height of the object.
vector3 overlay_color
 Color used for overlay image.
bool visible
 Whether scene object will be drawn.
ModelsArray models
 Array of models.
ModelItemactive_model
 Points to active model item.
bool resources_valid
RenderCallbackFun callback_render_begin
RenderCallbackFun callback_render_end

Classes

struct  ModelItem


Member Typedef Documentation

typedef void(* SceneObject::RenderCallbackFun)(void *)

typedef vector<ModelItem *> SceneObject::ModelsArray [protected]


Constructor & Destructor Documentation

SceneObject::SceneObject ( const char *  id  ) 

Constructor.

SceneObject::~SceneObject (  )  [virtual]

Destructor.


Member Function Documentation

byte_t SceneObject::AddModel ( const string &  model_file  ) 

bool SceneObject::ActivateModel ( byte_t  id  ) 

Model * SceneObject::GetActiveModel (  )  const [inline]

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

void SceneObject::SetPosition ( const vector3 position  )  [inline]

void SceneObject::SetSize ( const vector2 size  )  [inline]

const vector3 & SceneObject::GetPosition (  )  const [inline]

const vector2 & SceneObject::GetSize (  )  const [inline]

void SceneObject::SetVisible ( bool  visible  )  [inline]

bool SceneObject::IsVisible (  )  const [inline]

void SceneObject::SetRenderCallbacks ( RenderCallbackFun  render_begin,
RenderCallbackFun  render_end 
) [inline]

bool SceneObject::LoadResources (  ) 

bool SceneObject::IsResourcesValid (  )  const [inline]

void SceneObject::UpdateAnimators (  ) 

void SceneObject::PauseAnimators (  ) 

void SceneObject::Render ( bool  callbacks = true  )  const [inline]

void SceneObject::UnloadResources (  )  [protected]


Member Data Documentation

vector3 SceneObject::position [protected]

Position of the object.

vector2 SceneObject::size [protected]

Width and height of the object.

vector3 SceneObject::overlay_color [protected]

Color used for overlay image.

bool SceneObject::visible [protected]

Whether scene object will be drawn.

ModelsArray SceneObject::models [protected]

Array of models.

ModelItem* SceneObject::active_model [protected]

Points to active model item.

bool SceneObject::resources_valid [protected]

RenderCallbackFun SceneObject::callback_render_begin [protected]

RenderCallbackFun SceneObject::callback_render_end [protected]


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