VRUT::SceneNode Class Reference

Scene node for scene graph. More...

#include <scenenode.h>

Inheritance diagram for VRUT::SceneNode:

VRUT::ReadWriteMutex VRUT::Camera VRUT::GeometryNode VRUT::LightNode

List of all members.

Public Types

enum  SCENENODE_TYPE {
  ASSEMBLY = 0, ROOT = 1, CAMERA = 2, GEOMETRY = 4,
  LIGHT = 8
}
typedef std::list< NODE_ID > NodeIDList

Public Member Functions

 SceneNode (const wxString &_uid, const wxString &_name, SCENENODE_TYPE _type)
 Class constructor.
 SceneNode (const SceneNode &n)
 Copy constructor.
virtual ~SceneNode ()
 Class destructor.
const wxString & GetUid () const
 Get uid.
const wxString & GetName () const
 Get name.
NODE_ID GetID () const
 Get ID.
const MATRIX * GetLocalTransMatrix () const
 Get model space transofrmation matrix.
const MATRIX * GetWorldTransMatrix () const
const NodeIDList * GetChildren () const
 Get children list.
NODE_ID GetParent () const
 Get parent node.
bool IsValid () const
 Is node's transformation updated?
bool IsActive () const
 Is node active and should be drawn?
void SetActive (const bool _active)
 Is node active and should be drawn?
SCENENODE_TYPE GetType () const
 Get node type.
bool IsOfType (SCENENODE_TYPE _type) const
 Is node of given type?
virtual wxString ToString () const
 Get string with node's properties.
virtual SceneNode * Clone () const
 Get copy of instance.

Private Attributes

wxString uid
 Unique ID.
wxString name
 Name.
NODE_ID id
 ID.
SCENENODE_TYPE type
 Node type.
MATRIX localTransMatrix
 Local transformation matrix.
MATRIX worldTransMatrix
 World transformation matrix.
bool valid
 Is worldTransMatrix updated?
bool active
 Is node active?
NodeIDList children
 Children list.
NODE_ID parent
 Parent node.

Friends

class Scene

Detailed Description

Scene node for scene graph.

Definition at line 26 of file scenenode.h.

Member Typedef Documentation

typedef std::list<NODE_ID> VRUT::SceneNode::NodeIDList

Definition at line 29 of file scenenode.h.

Member Enumeration Documentation

enum VRUT::SceneNode::SCENENODE_TYPE

Enumerator:
ASSEMBLY  Assembly node.
ROOT  Root node.
CAMERA  Camera node.
GEOMETRY  Geometry node.
LIGHT  Light node.

Definition at line 31 of file scenenode.h.

00032               {
00033                      ASSEMBLY = 0,  
00034                      ROOT     = 1,  
00035                      CAMERA   = 2,  
00036                      GEOMETRY = 4,  
00037                      LIGHT    = 8   
00038               };

Constructor & Destructor Documentation

VRUT::SceneNode::SceneNode ( const wxString &  _uid,
const wxString &  _name,
SCENENODE_TYPE  _type 
) [inline]

Class constructor.

Definition at line 67 of file scenenode.h.

00068               : uid(CloneWxString(_uid)), name(CloneWxString(_name)), type(_type)
00069               {
00070                      wxASSERT_MSG(IsOk(), wxT("<SceneNode>Failed to create mutex"));
00071                      active = true;
00072                      valid = false;
00073                      id = parent = NODE_ID_NONE;
00074               }

VRUT::SceneNode::SceneNode ( const SceneNode &  n  )  [inline]

Copy constructor.

Definition at line 77 of file scenenode.h.

00078                      : ReadWriteMutex(), uid(CloneWxString(n.uid)), name(CloneWxString(n.name)), id(n.id), type(n.type),
00079                      localTransMatrix(n.localTransMatrix), worldTransMatrix(n.worldTransMatrix),
00080                      valid(n.valid), active(n.active), parent(n.parent)
00081               {
00082                      children.assign(n.children.begin(), n.children.end());
00083               }

virtual VRUT::SceneNode::~SceneNode (  )  [inline, virtual]

Class destructor.

Definition at line 86 of file scenenode.h.

00087               {
00088               }

Member Function Documentation

const wxString& VRUT::SceneNode::GetUid (  )  const [inline]

Get uid.

Definition at line 91 of file scenenode.h.

00092               {
00093                      return uid;
00094               }

const wxString& VRUT::SceneNode::GetName (  )  const [inline]

Get name.

Definition at line 97 of file scenenode.h.

00098               {
00099                      return name;
00100               }

NODE_ID VRUT::SceneNode::GetID (  )  const [inline]

Get ID.

Definition at line 103 of file scenenode.h.

00104               {
00105                      return id;
00106               }

const MATRIX* VRUT::SceneNode::GetLocalTransMatrix (  )  const [inline]

Get model space transofrmation matrix.

Definition at line 109 of file scenenode.h.

00110               {
00111                      return &localTransMatrix;
00112               }

const MATRIX* VRUT::SceneNode::GetWorldTransMatrix (  )  const [inline]

Get world transofrmation matrix

Returns:
NULL if matrix is not updated

Definition at line 116 of file scenenode.h.

00117               {
00118                      if (!valid)
00119                             LOGWARNING(wxT("<SceneNode>Getting invalid world transformation matrix - update first"));
00120                      return &worldTransMatrix;
00121               }

const NodeIDList* VRUT::SceneNode::GetChildren (  )  const [inline]

Get children list.

Definition at line 124 of file scenenode.h.

00125               {
00126                      return &children;
00127               }

NODE_ID VRUT::SceneNode::GetParent (  )  const [inline]

Get parent node.

Definition at line 130 of file scenenode.h.

00131               {
00132                      return parent;
00133               }

bool VRUT::SceneNode::IsValid (  )  const [inline]

Is node's transformation updated?

Definition at line 136 of file scenenode.h.

00137               {
00138                      return valid;
00139               }

bool VRUT::SceneNode::IsActive (  )  const [inline]

Is node active and should be drawn?

Definition at line 142 of file scenenode.h.

00143               {
00144                      return active;
00145               }

void VRUT::SceneNode::SetActive ( const bool  _active  )  [inline]

Is node active and should be drawn?

Definition at line 148 of file scenenode.h.

00149               {
00150                      active=_active;
00151               }

SCENENODE_TYPE VRUT::SceneNode::GetType (  )  const [inline]

Get node type.

Definition at line 154 of file scenenode.h.

00155               {
00156                      return type;
00157               }

bool VRUT::SceneNode::IsOfType ( SCENENODE_TYPE  _type  )  const [inline]

Is node of given type?

Definition at line 160 of file scenenode.h.

00161               {
00162                      return ( type == _type );
00163               }

virtual wxString VRUT::SceneNode::ToString (  )  const [inline, virtual]

Get string with node's properties.

Reimplemented in VRUT::Camera, VRUT::GeometryNode, and VRUT::LightNode.

Definition at line 166 of file scenenode.h.

00167               {
00168                      return wxString::Format(wxT("ID: %i\nName: %s\nType: %i\nLocal:\n%sWorld:\n%s"),
00169                             unsigned(GetID()),
00170                             GetName().c_str(),
00171                             type,
00172                             GetLocalTransMatrix()->ToString().c_str(),
00173                             ( IsValid() ? GetWorldTransMatrix()->ToString().c_str() : wxT("invalid\n") ));
00174               }

virtual SceneNode* VRUT::SceneNode::Clone (  )  const [inline, virtual]

Get copy of instance.

Reimplemented in VRUT::Camera, VRUT::GeometryNode, and VRUT::LightNode.

Definition at line 176 of file scenenode.h.

00177               {
00178                      return new SceneNode(*this);
00179               }

Friends And Related Function Documentation

friend class Scene [friend]

Reimplemented in VRUT::Camera, VRUT::GeometryNode, and VRUT::LightNode.

Definition at line 181 of file scenenode.h.

Member Data Documentation

wxString VRUT::SceneNode::uid [private]

Unique ID.

Definition at line 42 of file scenenode.h.

wxString VRUT::SceneNode::name [private]

Name.

Definition at line 44 of file scenenode.h.

NODE_ID VRUT::SceneNode::id [private]

ID.

Definition at line 46 of file scenenode.h.

SCENENODE_TYPE VRUT::SceneNode::type [private]

Node type.

Definition at line 48 of file scenenode.h.

MATRIX VRUT::SceneNode::localTransMatrix [private]

Local transformation matrix.

Definition at line 51 of file scenenode.h.

MATRIX VRUT::SceneNode::worldTransMatrix [private]

World transformation matrix.

Definition at line 53 of file scenenode.h.

bool VRUT::SceneNode::valid [private]

Is worldTransMatrix updated?

Definition at line 55 of file scenenode.h.

bool VRUT::SceneNode::active [private]

Is node active?

Definition at line 58 of file scenenode.h.

NodeIDList VRUT::SceneNode::children [private]

Children list.

Definition at line 61 of file scenenode.h.

NODE_ID VRUT::SceneNode::parent [private]

Parent node.

Definition at line 63 of file scenenode.h.

The documentation for this class was generated from the following file:
Generated on Tue Mar 10 14:41:45 2009 for VRUT by  doxygen 1.5.5