VRUT::SceneModule Class Reference

Module with access to scene manager. More...

#include <scenemodule.h>

Inheritance diagram for VRUT::SceneModule:

List of all members.

Public Member Functions
	SceneModule (const MODULE_ID &_id, const wxString &_name, unsigned _type, EventHandler *msgSink)
	Class constructor.
virtual	~SceneModule ()
	Class destructor.
void	SetSceneMgr (SceneManager *_sceneMgr)
	Set scene manager - should be set before module's thread is started.
SceneManager *	GetSceneMgr () const
	Get scene manager.
Protected Member Functions
virtual void	processEvent (wxCommandEvent &evt)
Protected Attributes
SceneManager *	sceneMgr
	Main scene manager in kernel.
SCENE_ID	sceneID
	Scene ID.
Parameter::ParameterIdentificator	sceneIDParamID
	Parameter identificator for sceneID.

---

Detailed Description

Module with access to scene manager.

Definition at line 21 of file scenemodule.h.

---

Constructor & Destructor Documentation

VRUT::SceneModule::SceneModule	(	const MODULE_ID &	_id,
		const wxString &	_name,
		unsigned	_type,
		EventHandler *	msgSink
	)			[inline]

Class constructor.

Definition at line 46 of file scenemodule.h.

                            : Module(_id, _name, (_type | MODULE_TYPE_SCENE), msgSink),
                            sceneMgr((SceneManager *)NULL), sceneID(SCENE_ID_NONE)
              {
                     REGISTER_PARAM_GUI_TEXTCONTROL(sceneIDParamID, wxT("sceneID"), wxString::Format(wxT("%i"), SCENE_ID_NONE), wxT("ID of scene to handle."));
              }

virtual VRUT::SceneModule::~SceneModule

(

)

[inline, virtual]

Class destructor.

Definition at line 54 of file scenemodule.h.

{}

---

Member Function Documentation

virtual void VRUT::SceneModule::processEvent

(

wxCommandEvent &

evt

)

[inline, protected, virtual]

Process general event Overload to process other events in derived module but do not forget to call this method

Reimplemented from VRUT::Module.

Reimplemented in VRUT::CameraManipulator, VRUT::IORdfModule, VRUT::IOStlModule, VRUT::Optimize, VRUT::RenderGl, VRUT::CameraModule, VRUT::IOModule, VRUT::ManipulatorModule, VRUT::RenderGlModule, VRUT::RenderModule, VRUT::_io, VRUT::_manip, VRUT::_render, VRUT::_scene, VRUT::_render, VRUT::ChcRenderer, VRUT::Collision_detection, VRUT::IOVrmlModule, VRUT::Navigation, VRUT::_render, VRUT::RayTracer, and VRUT::TrackingManipulator.

Definition at line 31 of file scenemodule.h.

              {
                     Module::processEvent(evt);
                     switch (evt.GetEventType())
                     {
                     case Event::EVT_PARAM_SET:
                            UPDATE_PARAM_FROM_EVENT_ID(sceneIDParamID, sceneID, evt);
                            break;
                     default:
                            break;
                     }
              }

void VRUT::SceneModule::SetSceneMgr

(

SceneManager *

_sceneMgr

)

[inline]

Set scene manager - should be set before module's thread is started.

Definition at line 57 of file scenemodule.h.

              {
                     sceneMgr = _sceneMgr;
              }

SceneManager* VRUT::SceneModule::GetSceneMgr

(

)

const [inline]

Get scene manager.

Definition at line 62 of file scenemodule.h.

              {
                     wxASSERT_MSG(sceneMgr, wxT("<SceneModule>Scene manager not defined, module was not initialized properly"));
                     return sceneMgr;
              }

---

Member Data Documentation

SceneManager* VRUT::SceneModule::sceneMgr [protected]

Main scene manager in kernel.

Definition at line 25 of file scenemodule.h.

SCENE_ID VRUT::SceneModule::sceneID [protected]

Scene ID.

Definition at line 27 of file scenemodule.h.

Parameter::ParameterIdentificator VRUT::SceneModule::sceneIDParamID [protected]

Parameter identificator for sceneID.

Definition at line 29 of file scenemodule.h.

---

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

• /cygdrive/d/src/svn/vrut/trunk/core/src/scenemodule.h