VRUT::JSScriptingModule Class Reference

Scripting class. More...

#include <jsscripting.h>

Inheritance diagram for VRUT::JSScriptingModule:

List of all members.

Public Member Functions
	JSScriptingModule (const MODULE_ID &_id, const wxString &_name, EventHandler *msgSink)
	Class constructor.
virtual	~JSScriptingModule ()
	Class destructor - deinitialize data.
virtual wxString	GetDesc () const
	Always overload method giving description for your module.
Protected Member Functions
virtual void	processEvent (wxCommandEvent &evt)
	Events processing.
virtual void	kernelRun ()
	Actions in the kernel loop.
Protected Attributes
unsigned	scriptActivation
	The script activity flag.
JSHandler *	handler
	JS processing class.
SCENE_ID	sceneID
	The scene identification number for script.
wxString	scriptPath
	The Script path.
Parameter::ParameterIdentificator	sceneParamID
	Parameter scene.
Parameter::ParameterIdentificator	pathParamID
	Parameter path.
Parameter::ParameterIdentificator	runParamID
	Parameter run.
Friends
class	JSHandler

---

Detailed Description

Scripting class.

Definition at line 25 of file jsscripting.h.

---

Constructor & Destructor Documentation

JSScriptingModule::JSScriptingModule	(	const MODULE_ID &	_id,
		const wxString &	_name,
		EventHandler *	msgSink
	)

Class constructor.

Create JSHandler for executing the script

Registering params

Registering all events listening

Definition at line 21 of file jsscripting.cpp.

                                                              :
       KernelModule(_id, _name, 0, msgSink)
{
       handler = new JSHandler(this);

       sceneID = 0;
       scriptPath = wxT("../modules/scripting/scripts/test.js");
       REGISTER_PARAM_GUI_TEXTCONTROL(sceneParamID, wxT("sceneID"), wxT("0"), wxT("ID of scene to handle."));
       REGISTER_PARAM_GUI_TEXTCONTROL(pathParamID, wxT("scriptPath"), scriptPath, wxT("Path of the script."));
       REGISTER_PARAM_GUI_BUTTON(runParamID, wxT("runScript"), wxT("runScript"));

       kernelMsgSink->UnregisterListener(GetID());
       REGISTER_LISTENER(Event::EVT_ALL);
       //REGISTER_LISTENER(Event::EVT_SCENE_NODE_INSERTED);
}

JSScriptingModule::~JSScriptingModule

(

)

[virtual]

Class destructor - deinitialize data.

Class destructor.

Definition at line 42 of file jsscripting.cpp.

{
       delete handler;
}

---

Member Function Documentation

void JSScriptingModule::processEvent

(

wxCommandEvent &

evt

)

[protected, virtual]

Events processing.

Calling the base method

Calling script synchronizer - checking waiting for event

Reimplemented from VRUT::Module.

Definition at line 48 of file jsscripting.cpp.

{
       Module::processEvent(evt);

       handler->ProcessEvent(evt);
       while (handler->RunScript())
              continue;

}

void JSScriptingModule::kernelRun

(

)

[protected, virtual]

Actions in the kernel loop.

Kernel thread method.

Implements VRUT::KernelModule.

Definition at line 62 of file jsscripting.cpp.

{

}

virtual wxString VRUT::JSScriptingModule::GetDesc

(

)

const [inline, virtual]

Always overload method giving description for your module.

Implements VRUT::Module.

Definition at line 62 of file jsscripting.h.

              {
                     return wxT("This is scripting module");
              }

---

Friends And Related Function Documentation

friend class JSHandler [friend]

Definition at line 68 of file jsscripting.h.

---

Member Data Documentation

unsigned VRUT::JSScriptingModule::scriptActivation [protected]

The script activity flag.

Definition at line 29 of file jsscripting.h.

JSHandler* VRUT::JSScriptingModule::handler [protected]

JS processing class.

Definition at line 32 of file jsscripting.h.

SCENE_ID VRUT::JSScriptingModule::sceneID [protected]

The scene identification number for script.

Definition at line 35 of file jsscripting.h.

wxString VRUT::JSScriptingModule::scriptPath [protected]

The Script path.

Definition at line 37 of file jsscripting.h.

Parameter::ParameterIdentificator VRUT::JSScriptingModule::sceneParamID [protected]

Parameter scene.

Definition at line 40 of file jsscripting.h.

Parameter::ParameterIdentificator VRUT::JSScriptingModule::pathParamID [protected]

Parameter path.

Definition at line 42 of file jsscripting.h.

Parameter::ParameterIdentificator VRUT::JSScriptingModule::runParamID [protected]

Parameter run.

Definition at line 44 of file jsscripting.h.

---

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

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