CEGUI Wiki - Crazy Eddie's GUI System (Open Source) - User contributions [en]

Custom ScriptingModule

2008-07-11T22:04:24Z

Rogma: /* A very basic event handler */

This article show how to create a custom ScriptingModule that can catch events.

This code has been tested with version 0.5.

==A very basic ScriptingModule==

This very basic scripting module link any event to a CommandInterpretor class.
/// Specialized scripting module for CEGUI
class ScriptingModule : public CEGUI::ScriptModule
{
public:

virtual CEGUI::Event::Connection subscribeEvent(
CEGUI::EventSet* target,
const CEGUI::String& name,
const CEGUI::String& subscriber_name)
{
CommandInterpretor command(subscriber_name.c_str()) ;
return target->subscribeEvent(name,CEGUI::Event::Subscriber(command)) ;
}

virtual CEGUI::Event::Connection subscribeEvent(
CEGUI::EventSet* target,
const CEGUI::String& name,
CEGUI::Event::Group group,
const CEGUI::String& subscriber_name)
{
CommandInterpretor command(subscriber_name.c_str()) ;
return target->subscribeEvent(name,group,CEGUI::Event::Subscriber(command)) ;
}

virtual void executeScriptFile(const CEGUI::String &filename, const CEGUI::String &resourceGroup="")
{}

virtual int executeScriptGlobal(const CEGUI::String& function_name)
{
return 0 ;
}

virtual void executeString(const CEGUI::String &str)
{}

virtual bool executeScriptedEventHandler(
const CEGUI::String& handler_name,
const CEGUI::EventArgs &e)
{
return true ;
}
};

The two important methods are subscribeEvent that link an event to a subscriber that is implemented by a basic event handler.

==A very basic event handler==

Here the ''main'' function is '''operator()''' that will be called with an EventArgs parameter. We already have the name of the function

/// Callback for a event command
class CommandInterpretor
{
public:

CommandInterpretor(const std::string& name)
: m_name(name)
{}

bool operator()(const CEGUI::EventArgs& args) const
{
std::cout << m_name ;

const CEGUI::WindowEventArgs* argument = dynamic_cast<const CEGUI::WindowEventArgs*>(&args) ;

if (argument)
{
// we have the window that triggered the event
std::cout << " " << argument->window->getName() ;
}

std::cout << std::endl ;

return true ;
}

std::string m_name ;

};

==Setup==

The ScriptModule can be registered to CEGUI::System either at construction time :
new CEGUI::System(CEGUIRenderer,0,0,module) ;
or after :
CEGUI::System::getSingleton().setScriptingModule(module) ;

==Example==

If you put :
<Event Name="Clicked" Function="play"/>
in the layout of a button named '''Foo''', you will have

play Foo

printed on screen

==Misc notes==

To also have the name of the event triggered, you can add this name to the constructor of CommandInterpretor.

Tutorials

2008-07-11T18:39:44Z

Rogma: /* Scripting with CEGUI */

=== CrazyEddie's Beginner Guides ===
* [[The Beginner Guide to Getting CEGUI Rendering]] - How to initialise CEGUI to render properly.
* [[The Beginner Guide to Resource Groups]] - How to define resource group locations and specify default resource groups.
* [[The Beginner Guide to Loading Data Files and Initialisation]] - How to load some data files and perform basic system initialisation.
* [[The Beginner Guide to Creating a CEGUI Window]] - How to create a simple window and get it on screen.
* [[The Beginner Guide to Injecting Inputs]] - How to inject inputs into CEGUI and get interactive.
* [[HOWTO:_Use_the_Unified_Positions_and_Sizes_System|The Beginner Guide to the Unified Position and Size System (CEGUI >= 0.4.0)]]

=== Scripting with CEGUI ===
* [[Getting Started with Lua and CEGUI]] - How to initialise CEGUI with a Lua script module and configuration file.
* [[Handling Events from Lua]] - How to load Lua script files and bind CEGUI events to Lua functions.
* [[Writing CEGUI scripts]] - Code snippets
* [[Adding LuaScriptModule to Sample_FirstWindow]] - Experience adding scripting to an existing sample.
* [http://www.gpwiki.org/index.php/Crazy_Eddies_GUI_System:Tutorials:Creating_a_scriptable_interface_using_CEGUI Creating a scriptable interface using CEGUI]
* [[Custom_ScriptingModule]] - Creating a basic custom scripting module in CEGUI

=== Window System Examples ===
* [[Using CEGUI with SDL and OpenGL]] - Guidelines on how to get SDL, OpenGL and CEGUI running together.
* [[Using CEGUI with Producer and OpenGL]] - Guidelines on how to render and inject input to CEGUI from the Producer API.
* [http://artis.imag.fr/Membres/Xavier.Decoret/resources/CEGUI/ Using CEGUI with Qt/QGLViewer]
* [[Using CEGUI with GLUT]] - Some tips on using OpenGL's GLUT with CEGUI.

=== Extending CEGUI ===

* [[Using Expat XML parser within CEGUI]] - How to add support for another XML parser.

=== Skins - Tutorial For Artists ===
* [[Creating Skins]] - Extra notes for artists on how to create skins.
* [[The Beginners Guide to Falagard skinning - Part I]] - Learn by doing a Button.
* [[The Beginners Guide to Falagard skinning - Part II]] - More Falagard fun, this time with the Editbox.

=== Overviews ===
* [[Overview of GUI files]] - A quick introduction to all the XML files used by CEGUI.

=== Miscellaneous HOW-TOs ===
* [[Create ImageButtons]] - A few different ways to create image buttons.
* [[Create a CheckListboxItem]] - Create a CheckListBoxItem that you can use with ItemListbox.
* [[Identifying Multiple Event Sources From A Single Callback]]
* [[Cool_window_effects]] - A collection of cool "special" effects on (frame)windows.

Custom ScriptingModule

2008-07-11T18:35:46Z

Rogma:

This article show how to create a custom ScriptingModule that can catch events.

This code has been tested with version 0.5.

==A very basic ScriptingModule==

This very basic scripting module link any event to a CommandInterpretor class.
/// Specialized scripting module for CEGUI
class ScriptingModule : public CEGUI::ScriptModule
{
public:

virtual CEGUI::Event::Connection subscribeEvent(
CEGUI::EventSet* target,
const CEGUI::String& name,
const CEGUI::String& subscriber_name)
{
CommandInterpretor command(subscriber_name.c_str()) ;
return target->subscribeEvent(name,CEGUI::Event::Subscriber(command)) ;
}

virtual CEGUI::Event::Connection subscribeEvent(
CEGUI::EventSet* target,
const CEGUI::String& name,
CEGUI::Event::Group group,
const CEGUI::String& subscriber_name)
{
CommandInterpretor command(subscriber_name.c_str()) ;
return target->subscribeEvent(name,group,CEGUI::Event::Subscriber(command)) ;
}

virtual void executeScriptFile(const CEGUI::String &filename, const CEGUI::String &resourceGroup="")
{}

virtual int executeScriptGlobal(const CEGUI::String& function_name)
{
return 0 ;
}

virtual void executeString(const CEGUI::String &str)
{}

virtual bool executeScriptedEventHandler(
const CEGUI::String& handler_name,
const CEGUI::EventArgs &e)
{
return true ;
}
};

The two important methods are subscribeEvent that link an event to a subscriber that is implemented by a basic event handler.

==A very basic event handler==

Here the ''main'' function is '''operator()''' that will be called with an EventArgs parameter. We already have the name of the function

/// Callback for a event command
class CommandInterpretor
{
public:

CommandInterpretor(const std::string& name)
: m_name(name)
{}

bool operator()(const CEGUI::EventArgs& args) const
{
std::cout << m_name ;

const CEGUI::WindowEventArgs* argument = dynamic_cast<const CEGUI::WindowEventArgs*>(&args) ;

if (argument)
{
// we have the window that triggered the event
std::cout << " " << argument->window->getName() ;
}

std::cout << std::endl ;

return true ;
}

string m_name ;

};

==Setup==

The ScriptModule can be registered to CEGUI::System either at construction time :
new CEGUI::System(CEGUIRenderer,0,0,module) ;
or after :
CEGUI::System::getSingleton().setScriptingModule(module) ;

==Example==

If you put :
<Event Name="Clicked" Function="play"/>
in the layout of a button named '''Foo''', you will have

play Foo

printed on screen

==Misc notes==

To also have the name of the event triggered, you can add this name to the constructor of CommandInterpretor.