VRUT::ScriptNode Class Reference

The ScriptScene class accesses the Scene class. More...

#include <scriptnode.h>

List of all members.

Public Member Functions
	ScriptNode (ScriptScene *_ss, SCENE_ID sid, NODE_ID nid)
NODE_ID	GetID () throw (NodeScriptException, SceneScriptException)
const wxString &	GetName () throw (NodeScriptException, SceneScriptException)
const wxString &	GetUid () throw (NodeScriptException, SceneScriptException)
const MATRIX *	GetLocalTransMatrix () throw (NodeScriptException, SceneScriptException)
const MATRIX *	GetWorldTransMatrix () throw (NodeScriptException, SceneScriptException)
const SceneNode::NodeIDList *	GetChildren () throw (NodeScriptException, SceneScriptException)
NODE_ID	GetParent () throw (NodeScriptException, SceneScriptException)
bool	IsValid () throw (NodeScriptException, SceneScriptException)
bool	IsActive () throw (NodeScriptException, SceneScriptException)
SceneNode::SCENENODE_TYPE	GetType () throw (NodeScriptException, SceneScriptException)
bool	IsOfType (SceneNode::SCENENODE_TYPE _type) throw (NodeScriptException, SceneScriptException)
Private Member Functions
const SceneNode *	getNode () throw (NodeScriptException, SceneScriptException)
	The method for getting SceneNode which this class accesses.
Private Attributes
Kernel *	kernel
	The Kernel pointer.
ScriptScene *	ss
	The ScriptScene pointer.
SCENE_ID	sceneID
	The scene ID.
NODE_ID	nodeID
	The node ID.

---

Detailed Description

The ScriptScene class accesses the Scene class.

Definition at line 24 of file scriptnode.h.

---

Constructor & Destructor Documentation

VRUT::ScriptNode::ScriptNode	(	ScriptScene *	_ss,
		SCENE_ID	sid,
		NODE_ID	nid
	)			[inline]

Definition at line 40 of file scriptnode.h.

                     : ss(_ss), kernel(_ss->kernel), sceneID(sid), nodeID(nid) {}

---

Member Function Documentation

const SceneNode * ScriptNode::getNode

(

)

throw (NodeScriptException, SceneScriptException) [private]

The method for getting SceneNode which this class accesses.

Definition at line 20 of file scriptnode.cpp.

{
       Scene *scene = ss->getScene();
       const SceneNode *node = scene->GetNode(nodeID);
       if (!node)
       {
              ss->deleteScriptNode(nodeID);
              throw NodeScriptException();
       }
       return node;
}

NODE_ID VRUT::ScriptNode::GetID

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 43 of file scriptnode.h.

              {
                     return getNode()->GetID();
              }

const wxString& VRUT::ScriptNode::GetName

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 48 of file scriptnode.h.

              {
                     return getNode()->GetName();
              }

const wxString& VRUT::ScriptNode::GetUid

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 53 of file scriptnode.h.

              {
                     return getNode()->GetUid();
              }

const MATRIX* VRUT::ScriptNode::GetLocalTransMatrix

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 58 of file scriptnode.h.

              {
                     return getNode()->GetLocalTransMatrix();
              }

const MATRIX* VRUT::ScriptNode::GetWorldTransMatrix

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 63 of file scriptnode.h.

              {
                     return getNode()->GetWorldTransMatrix();
              }

const SceneNode::NodeIDList* VRUT::ScriptNode::GetChildren

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 68 of file scriptnode.h.

              {
                     return getNode()->GetChildren();
              }

NODE_ID VRUT::ScriptNode::GetParent

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 73 of file scriptnode.h.

              {
                     return getNode()->GetParent();
              }

bool VRUT::ScriptNode::IsValid

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 78 of file scriptnode.h.

              {
                     return getNode()->IsValid();
              }

bool VRUT::ScriptNode::IsActive

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 83 of file scriptnode.h.

              {
                     return getNode()->IsActive();
              }

SceneNode::SCENENODE_TYPE VRUT::ScriptNode::GetType

(

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 88 of file scriptnode.h.

              {
                     return getNode()->GetType();
              }

bool VRUT::ScriptNode::IsOfType

(

SceneNode::SCENENODE_TYPE

_type

)

throw (NodeScriptException, SceneScriptException) [inline]

Definition at line 93 of file scriptnode.h.

              {
                     return getNode()->IsOfType(_type);
              }

---

Member Data Documentation

Kernel* VRUT::ScriptNode::kernel [private]

The Kernel pointer.

Definition at line 28 of file scriptnode.h.

ScriptScene* VRUT::ScriptNode::ss [private]

The ScriptScene pointer.

Definition at line 30 of file scriptnode.h.

SCENE_ID VRUT::ScriptNode::sceneID [private]

The scene ID.

Definition at line 32 of file scriptnode.h.

NODE_ID VRUT::ScriptNode::nodeID [private]

The node ID.

Definition at line 34 of file scriptnode.h.

---

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

• /cygdrive/d/src/svn/vrut/trunk/modules/scripting/scriptnode.h
• /cygdrive/d/src/svn/vrut/trunk/modules/scripting/scriptnode.cpp