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

Porting tips and changes from 0.7.X to 0.8.X

2014-07-02T16:06:48Z

Kornerr: root window and rearranged my previous edits

{{VersionBadge|0.7}}

{{Section|1=Introduction|2=
The 0.8.x branch has already seen releases. Please see the sourceforge page for tarball downloads.
}}
{{Section|1=Major renames/API changes|2=
* FalagardWRBase was renamed to CoreWindowRendererSet
* Windows now don't have absolute names! Every window's name only has to be unique in it's parent window. Therefore WindowManager::getSingleton().getWindow no longer made sense and was removed. If root's name was "Root" and your the window name was "Root/Stuff/After/Root/Name", you can emulate its behaviour with root->getChild("Stuff/After/Root/Name"). It's recommended to migrate to a more encapsulated model.
* CEGUI::GUIContext class has been created that is responsible for injecting input and event handling, setting the default font, setting the root window, setting a default tooltip object and type, and manipulating the mouse cursor.
* CEGUI::GUIContext needs time impulses injected separately! You should also inject time pulses into CEGUI::System. This API "wart" may disappear in future versions.
* CEGUI::MouseCursor is no longer a singleton, and can be accessed and manipulated from CEGUI::GUIContext.
}}
{{Section|1=General|2=
* All XML attributes must now be in lowercase, e.g. <WidgetLook Name="TaharezLook/FrameWindow"> must be <WidgetLook name="TaharezLook/FrameWindow">
* PropertyHelper has been turned into a template class, instead of PropertyHelper::uintToString you do PropertyHelper<uint>::toString, instead of PropertyHelper::stringToUint you do PropertyHelper<uint>::fromString
* All instances of the word caret that were incorrectly spelt 'carat' have been corrected. This affects all APIs, properties, events and datafiles.
* Window::EventWindowUpdated renamed to Window::EventUpdated and the associated string is changed from "WindowUpdate" to "Updated"
* ListHeader::SegmentNameSuffix changed type from character array to CEGUI::String
* BiDiVisualMapping renamed to BidiVisualMapping. Also renamed the files, so CEGUIBiDiVisualMapping.h is now CEGUIBidiVisualMapping.h
* class colour renamed to Colour, as a side effect the "colour" interpolator is now "Colour" interpolator, this breaks animation definitions!
* Point typedef removed, please use Vector2 instead
* Many event string values changed to match the C++ name (but without the Event prefix). A list of which strings changed value will appear here soon.
* Window::setRestoreCapture renamed to Window::setRestoreOldCapture
* CEGUI now supports custom memory allocation, see [[Memory Allocation]] to check if this concerns you or not.
* Window::addChildWindow renamed to Window::addChild, Window::removeChildWindow renamed to Window::removeChild, several other methods (mostly in layout containers) changed from *ChildWindow* to *Child*
* CEGUI::String can now be just a typedef or a class, depending on String configuration (CEGUI can now use std::string as CEGUI::String for apps not requiring unicode)
* Window::getChild_impl method completely removed, it was only used by Window::getParentPixelSize, shouldn't be hard to replace
* Vector2, Vector3, Size and Rect are now templated, you should use Vector2<float> (or just Vector2<> as a shortcut since float is the default type) instead of Vector2, UVector2 class was removed, UVector2 is now just a typedef to Vector2<UDim>. Same with Vector3, Size and Rect.
* Texture::saveToMemory is renamed Texture::blitToMemory.
* Renderer and Texture interfaces changed in order to support named textures.
* Window::isDisabled(localOnly) is now split into Window::isDisabled (= old isDisabled(true) and Window::isEffectiveDisabled (= old isDisabled(false))
* Window::isVisible(localOnly) is now split into Window::isVisible (= old isDisabled(true) and Window::isEffectiveVisible (= old isVisible(false))
* WindowManager::loadWindowLayout is renamed to WindowManager::loadLayoutFromFile
* NamedXMLResourceManager::create is renamed to NamedXMLResourceManager::createFromFile (Ex. CEGUI::SchemeManager::createFromFile)
* CEGUI::DefaultLogger no longer throws const char* but a real exception in setLogFilename - http://www.cegui.org.uk/mantis/view.php?id=443
* CEGUI now has inbuilt copy, cut, paste support, if you used a custom solution, you might want to check CEGUI::Clipboard and System::inject{Copy,Cut,Paste}Request
* CEGUI::ProgressBar::getStep renamed to getStepSize for consistency with setStepSize
* CEGUI::WidgetLookManager::parseLookNFeelSpecification is now called parseLookNFeelSpecificationFromFile, variants for loading from string and raw data container have been added
* XRotation, YRotation, ZRotation properties merged into the new Rotation property, which is a Quaternion.
}}
{{Section|1=Property Name Changes|2=
* Property from Window called "ZOrderChangeEnabled" renamed to "ZOrderingEnabled"
* Property from Window called "MouseButtonDownAutoRepeat" renamed to "MouseAutoRepeatEnabled"
* Property from Window called "CustomTooltipType" renamed to "TooltipType"
* Property from Window called "Tooltip" renamed to "TooltipText"
* Property from Window called "RiseOnClick" renamed to "RiseOnClickEnabled"
* Property from Window called "UnifiedAreaRect" renamed to "Area", "UnifiedSize" renamed to "Size", etc...
* Property "MaxEditTextLength" renamed to "MaxTextLength"
}}
{{Section|1=Event Name Changes|2=
* EventMouseEnters renamed to EventMouseEntersSurface (old name removed)
* EventMouseLeaves renamed to EventMouseLeavesSurface (old name removed)
* CheckStateChanged renamed to SelectStateChanged (for ToggleButton (old Checkbox))
}}
{{Section|1=Image and ImageManager|2=
* Image::draw renamed to Image::render
* Image class is now an abstract interface. BasicImage implementation is provided, and used for internally created Image objects.
* Imageset class is removed. It remains a CEGUI format that allows to conveniently define multiple images on one texture but the data is no longer stored in any class. When Imageset is loaded, the ImageManager creates a new BasicImage for each of the images in the imageset. Only the images themselves will remain after imageset is loaded. You now use the new ImageManager to access defined images.
* ImagesetManager class is removed. You now use the new ImageManager.
* Images belonging to a certain imageset can be accessed like so: "ImageSetName/ImageName" (ex. "AlfiskoSkin/MouseArrow").
}}
{{Section|1=GUIContext|2=
A lot of API has been moved from CEGUI::System to CEGUI::GUIContext. CEGUI now allows you to create multiple independent GUI contexts with their own input injection.

As a rule of thumb, whenever you see "There is no CEGUI::System::some_foobar_method method", it is likely that you can replace the call with CEGUI::System::getSingleton().getDefaultGUIContext().someFoobarMethod(). This holds for all the System::inject* methods for example.

Exceptions from the rule:
* CEGUI::System::getSingleton().renderGUI() → CEGUI::System::getSingleton().renderAllGUIContexts()
* CEGUI::System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow") ? CEGUI::System::getSingleton().getDefaultGUIContext().getMouseCursor().setDefaultImage("TaharezLook/MouseArrow")
* CEGUI::System::getSingleton().setGUISheet(root) → CEGUI::System::getSingleton().getDefaultGUIContext().setRootWindow(root)

WindowManager::getSingleton().getWindow() was removed. You can emulate its behaviour with root->getChild("Stuff/After/Root/Name").
To get Root Window you can call GUIContext::getRootWindow();

SIDE NOTE: The chain call of methods CEGUI::System::getSingleton().getDefaultGUIContext() should be called as rarely as possible, instead one should keep it's result in appropriate variable.

}}
{{Section|1=PyCEGUI|2=
* EventSet.subscribeEvent now has a different, more pythonic syntax, any python callable (bound member function, free function, lambda, functor, ...) is allowed (EventSet.subscribeEvent("EventName", instance, "someMethodInIt") is now EventSet.subscribeEvent("EventName", instance.someMethodInIt)
}}

{{Section|1=Datafiles|2=
* All XML datafiles must specify a version attribute. Example: <GUILayout '''version="4"'''>
* All attributes in datafiles must begin with a lower-case letter. Example: <Property '''n'''ame="Alpha" '''v'''alue="1.0" />
* See '''Property Name Changes''' and '''Event Name Changes''' above

* '''.looknfeel:'''
** <Falagard version="7">
** old: <Image '''type'''="TopEdge" '''imageset'''="TaharezLook" '''image'''="TitlebarTop" /> new: <Image '''component'''="TopEdge" '''name'''="TaharezLook/TitlebarTop" />
** Change: MaxEditTextLength → MaxTextLength
** Change: MouseButtonDownAutoRepeat → MouseAutoRepeatEnabled
** Change: DimOperator → OperatorDim. Please compare [http://static.cegui.org.uk/docs/0.7.9/fal_element_ref.html#fal_elem_ref_sec_10 0.7.9] with [http://static.cegui.org.uk/docs/current/fal_element_ref.html#fal_elem_ref_sec_operatordim latest] for functional change description
*** old formatting: VALUE1 { DIMOPERATOR() { VALUE2 } } new formatting: OPERATORDIM() { VALUE1, VALUE2 }
* '''.scheme:'''
** <GUIScheme name="MySkin" version="5">
** Change: <WindowRendererSet Filename="CEGUIFalagardWRBase" /> → <WindowRendererSet filename="CEGUICoreWindowRendererSet" />
** Change: renderer="Falagard/... → renderer="Core/...
** Change: "Core/SystemButton" → "Core/Button"
** Change: "CEGUI/Checkbox" → "CEGUI/ToggleButton"
* '''.layout:'''
** <GUILayout version="4">
** UnifiedPosition, UnifiedAreaRect, UnifiedSize, UnifiedMinSize, UnifiedMaxSize → Position, Area, Size, MinSize, MaxSize
** Tooltip → TooltipText
** old: <Property name="Image" value="set:Buttons image:Settings" /> new: <Property name="Image" value="Buttons/Settings" />
* '''.imageset:'''
** <Imageset version="2" ... />
* '''.font:'''
** 

* If you build your own version of ceed (see this guide - http://cegui.org.uk/wiki/Building_CEED_for_Windows), you can then use the ceed-migrate tool to automate and batch all of the changes discussed in this section. See here for a quick guide to using ceed-migrate - http://cegui.org.uk/wiki/Using_CEED-Migrate
}}
[[Category:Manuals]]

Porting tips and changes from 0.7.X to 0.8.X

2014-07-02T15:49:30Z

Kornerr: mouse cursor

{{VersionBadge|0.7}}

{{Section|1=Introduction|2=
The 0.8.x branch has already seen releases. Please see the sourceforge page for tarball downloads.
}}
{{Section|1=Major renames/API changes|2=
* FalagardWRBase was renamed to CoreWindowRendererSet
* Windows now don't have absolute names! Every window's name only has to be unique in it's parent window. Therefore WindowManager::getSingleton().getWindow no longer made sense and was removed. If root's name was "Root" and your the window name was "Root/Stuff/After/Root/Name", you can emulate its behaviour with root->getChild("Stuff/After/Root/Name"). It's recommended to migrate to a more encapsulated model.
* CEGUI::GUIContext class has been created that is responsible for injecting input and event handling, setting the default font, setting the root window, setting a default tooltip object and type, and manipulating the mouse cursor.
* CEGUI::GUIContext needs time impulses injected separately! You should also inject time pulses into CEGUI::System. This API "wart" may disappear in future versions.
* CEGUI::MouseCursor is no longer a singleton, and can be accessed and manipulated from CEGUI::GUIContext.
** CEGUI::System::getSingleton().setDefaultMouseCursor("TaharezLook", "MouseArrow") → CEGUI::System::getSingleton().getDefaultGUIContext().getMouseCursor().setDefaultImage("TaharezLook/MouseArrow")
}}
{{Section|1=General|2=
* All XML attributes must now be in lowercase, e.g. <WidgetLook Name="TaharezLook/FrameWindow"> must be <WidgetLook name="TaharezLook/FrameWindow">
* PropertyHelper has been turned into a template class, instead of PropertyHelper::uintToString you do PropertyHelper<uint>::toString, instead of PropertyHelper::stringToUint you do PropertyHelper<uint>::fromString
* All instances of the word caret that were incorrectly spelt 'carat' have been corrected. This affects all APIs, properties, events and datafiles.
* Window::EventWindowUpdated renamed to Window::EventUpdated and the associated string is changed from "WindowUpdate" to "Updated"
* ListHeader::SegmentNameSuffix changed type from character array to CEGUI::String
* BiDiVisualMapping renamed to BidiVisualMapping. Also renamed the files, so CEGUIBiDiVisualMapping.h is now CEGUIBidiVisualMapping.h
* class colour renamed to Colour, as a side effect the "colour" interpolator is now "Colour" interpolator, this breaks animation definitions!
* Point typedef removed, please use Vector2 instead
* Many event string values changed to match the C++ name (but without the Event prefix). A list of which strings changed value will appear here soon.
* Window::setRestoreCapture renamed to Window::setRestoreOldCapture
* CEGUI now supports custom memory allocation, see [[Memory Allocation]] to check if this concerns you or not.
* Window::addChildWindow renamed to Window::addChild, Window::removeChildWindow renamed to Window::removeChild, several other methods (mostly in layout containers) changed from *ChildWindow* to *Child*
* CEGUI::String can now be just a typedef or a class, depending on String configuration (CEGUI can now use std::string as CEGUI::String for apps not requiring unicode)
* Window::getChild_impl method completely removed, it was only used by Window::getParentPixelSize, shouldn't be hard to replace
* Vector2, Vector3, Size and Rect are now templated, you should use Vector2<float> (or just Vector2<> as a shortcut since float is the default type) instead of Vector2, UVector2 class was removed, UVector2 is now just a typedef to Vector2<UDim>. Same with Vector3, Size and Rect.
* Texture::saveToMemory is renamed Texture::blitToMemory.
* Renderer and Texture interfaces changed in order to support named textures.
* Window::isDisabled(localOnly) is now split into Window::isDisabled (= old isDisabled(true) and Window::isEffectiveDisabled (= old isDisabled(false))
* Window::isVisible(localOnly) is now split into Window::isVisible (= old isDisabled(true) and Window::isEffectiveVisible (= old isVisible(false))
* WindowManager::loadWindowLayout is renamed to WindowManager::loadLayoutFromFile
* NamedXMLResourceManager::create is renamed to NamedXMLResourceManager::createFromFile (Ex. CEGUI::SchemeManager::createFromFile)
* CEGUI::DefaultLogger no longer throws const char* but a real exception in setLogFilename - http://www.cegui.org.uk/mantis/view.php?id=443
* CEGUI now has inbuilt copy, cut, paste support, if you used a custom solution, you might want to check CEGUI::Clipboard and System::inject{Copy,Cut,Paste}Request
* CEGUI::ProgressBar::getStep renamed to getStepSize for consistency with setStepSize
* CEGUI::WidgetLookManager::parseLookNFeelSpecification is now called parseLookNFeelSpecificationFromFile, variants for loading from string and raw data container have been added
* XRotation, YRotation, ZRotation properties merged into the new Rotation property, which is a Quaternion.
}}
{{Section|1=Property Name Changes|2=
* Property from Window called "ZOrderChangeEnabled" renamed to "ZOrderingEnabled"
* Property from Window called "MouseButtonDownAutoRepeat" renamed to "MouseAutoRepeatEnabled"
* Property from Window called "CustomTooltipType" renamed to "TooltipType"
* Property from Window called "Tooltip" renamed to "TooltipText"
* Property from Window called "RiseOnClick" renamed to "RiseOnClickEnabled"
* Property from Window called "UnifiedAreaRect" renamed to "Area", "UnifiedSize" renamed to "Size", etc...
* Property "MaxEditTextLength" renamed to "MaxTextLength"
}}
{{Section|1=Event Name Changes|2=
* EventMouseEnters renamed to EventMouseEntersSurface (old name removed)
* EventMouseLeaves renamed to EventMouseLeavesSurface (old name removed)
* CheckStateChanged renamed to SelectStateChanged (for ToggleButton (old Checkbox))
}}
{{Section|1=Image and ImageManager|2=
* Image::draw renamed to Image::render
* Image class is now an abstract interface. BasicImage implementation is provided, and used for internally created Image objects.
* Imageset class is removed. It remains a CEGUI format that allows to conveniently define multiple images on one texture but the data is no longer stored in any class. When Imageset is loaded, the ImageManager creates a new BasicImage for each of the images in the imageset. Only the images themselves will remain after imageset is loaded. You now use the new ImageManager to access defined images.
* ImagesetManager class is removed. You now use the new ImageManager.
* Images belonging to a certain imageset can be accessed like so: "ImageSetName/ImageName" (ex. "AlfiskoSkin/MouseArrow").
}}
{{Section|1=GUIContext|2=
A lot of API has been moved from CEGUI::System to CEGUI::GUIContext. CEGUI now allows you to create multiple independent GUI contexts with their own input injection.

As a rule of thumb, whenever you see "There is no CEGUI::System::some_foobar_method method", it is likely that you can replace the call with CEGUI::System::getSingleton().getDefaultGUIContext().someFoobarMethod(). This holds for all the System::inject* methods for example.

Exceptions from the rule:
* CEGUI::System::getSingleton().renderGUI() → CEGUI::System::getSingleton().renderAllGUIContexts()

WindowManager::getSingleton().getWindow() was removed. You can emulate its behaviour with root->getChild("Stuff/After/Root/Name").
To get Root Window you can call GUIContext::getRootWindow();

SIDE NOTE: The chain call of methods CEGUI::System::getSingleton().getDefaultGUIContext() should be called as rarely as possible, instead one should keep it's result in appropriate variable.

}}
{{Section|1=PyCEGUI|2=
* EventSet.subscribeEvent now has a different, more pythonic syntax, any python callable (bound member function, free function, lambda, functor, ...) is allowed (EventSet.subscribeEvent("EventName", instance, "someMethodInIt") is now EventSet.subscribeEvent("EventName", instance.someMethodInIt)
}}

{{Section|1=Datafiles|2=
* All XML datafiles must specify a version attribute. Example: <GUILayout '''version="4"'''>
* All attributes in datafiles must begin with a lower-case letter. Example: <Property '''n'''ame="Alpha" '''v'''alue="1.0" />
* See '''Property Name Changes''' and '''Event Name Changes''' above

* '''.looknfeel:'''
** <Falagard version="7">
** old: <Image '''type'''="TopEdge" '''imageset'''="TaharezLook" '''image'''="TitlebarTop" /> new: <Image '''component'''="TopEdge" '''name'''="TaharezLook/TitlebarTop" />
** Change: MaxEditTextLength → MaxTextLength
** Change: MouseButtonDownAutoRepeat → MouseAutoRepeatEnabled
** Change: DimOperator → OperatorDim. Please compare [http://static.cegui.org.uk/docs/0.7.9/fal_element_ref.html#fal_elem_ref_sec_10 0.7.9] with [http://static.cegui.org.uk/docs/current/fal_element_ref.html#fal_elem_ref_sec_operatordim latest] for functional change description
*** old formatting: VALUE1 { DIMOPERATOR() { VALUE2 } } new formatting: OPERATORDIM() { VALUE1, VALUE2 }
* '''.scheme:'''
** <GUIScheme name="MySkin" version="5">
** Change: <WindowRendererSet Filename="CEGUIFalagardWRBase" /> → <WindowRendererSet filename="CEGUICoreWindowRendererSet" />
** Change: renderer="Falagard/... → renderer="Core/...
** Change: "Core/SystemButton" → "Core/Button"
** Change: "CEGUI/Checkbox" → "CEGUI/ToggleButton"
* '''.layout:'''
** <GUILayout version="4">
** UnifiedPosition, UnifiedAreaRect, UnifiedSize, UnifiedMinSize, UnifiedMaxSize → Position, Area, Size, MinSize, MaxSize
** Tooltip → TooltipText
** old: <Property name="Image" value="set:Buttons image:Settings" /> new: <Property name="Image" value="Buttons/Settings" />
* '''.imageset:'''
** <Imageset version="2" ... />
* '''.font:'''
** 

* If you build your own version of ceed (see this guide - http://cegui.org.uk/wiki/Building_CEED_for_Windows), you can then use the ceed-migrate tool to automate and batch all of the changes discussed in this section. See here for a quick guide to using ceed-migrate - http://cegui.org.uk/wiki/Using_CEED-Migrate
}}
[[Category:Manuals]]

Porting tips and changes from 0.7.X to 0.8.X

2014-07-02T15:33:50Z

Kornerr: renderAllGUIContexts

{{VersionBadge|0.7}}

{{Section|1=Introduction|2=
The 0.8.x branch has already seen releases. Please see the sourceforge page for tarball downloads.
}}
{{Section|1=Major renames/API changes|2=
* FalagardWRBase was renamed to CoreWindowRendererSet
* Windows now don't have absolute names! Every window's name only has to be unique in it's parent window. Therefore WindowManager::getSingleton().getWindow no longer made sense and was removed. If root's name was "Root" and your the window name was "Root/Stuff/After/Root/Name", you can emulate its behaviour with root->getChild("Stuff/After/Root/Name"). It's recommended to migrate to a more encapsulated model.
* CEGUI::GUIContext class has been created that is responsible for injecting input and event handling, setting the default font, setting the root window, setting a default tooltip object and type, and manipulating the mouse cursor.
* CEGUI::GUIContext needs time impulses injected separately! You should also inject time pulses into CEGUI::System. This API "wart" may disappear in future versions.
* CEGUI::MouseCursor is no longer a singleton, and can be accessed and manipulated from CEGUI::GUIContext.
}}
{{Section|1=General|2=
* All XML attributes must now be in lowercase, e.g. <WidgetLook Name="TaharezLook/FrameWindow"> must be <WidgetLook name="TaharezLook/FrameWindow">
* PropertyHelper has been turned into a template class, instead of PropertyHelper::uintToString you do PropertyHelper<uint>::toString, instead of PropertyHelper::stringToUint you do PropertyHelper<uint>::fromString
* All instances of the word caret that were incorrectly spelt 'carat' have been corrected. This affects all APIs, properties, events and datafiles.
* Window::EventWindowUpdated renamed to Window::EventUpdated and the associated string is changed from "WindowUpdate" to "Updated"
* ListHeader::SegmentNameSuffix changed type from character array to CEGUI::String
* BiDiVisualMapping renamed to BidiVisualMapping. Also renamed the files, so CEGUIBiDiVisualMapping.h is now CEGUIBidiVisualMapping.h
* class colour renamed to Colour, as a side effect the "colour" interpolator is now "Colour" interpolator, this breaks animation definitions!
* Point typedef removed, please use Vector2 instead
* Many event string values changed to match the C++ name (but without the Event prefix). A list of which strings changed value will appear here soon.
* Window::setRestoreCapture renamed to Window::setRestoreOldCapture
* CEGUI now supports custom memory allocation, see [[Memory Allocation]] to check if this concerns you or not.
* Window::addChildWindow renamed to Window::addChild, Window::removeChildWindow renamed to Window::removeChild, several other methods (mostly in layout containers) changed from *ChildWindow* to *Child*
* CEGUI::String can now be just a typedef or a class, depending on String configuration (CEGUI can now use std::string as CEGUI::String for apps not requiring unicode)
* Window::getChild_impl method completely removed, it was only used by Window::getParentPixelSize, shouldn't be hard to replace
* Vector2, Vector3, Size and Rect are now templated, you should use Vector2<float> (or just Vector2<> as a shortcut since float is the default type) instead of Vector2, UVector2 class was removed, UVector2 is now just a typedef to Vector2<UDim>. Same with Vector3, Size and Rect.
* Texture::saveToMemory is renamed Texture::blitToMemory.
* Renderer and Texture interfaces changed in order to support named textures.
* Window::isDisabled(localOnly) is now split into Window::isDisabled (= old isDisabled(true) and Window::isEffectiveDisabled (= old isDisabled(false))
* Window::isVisible(localOnly) is now split into Window::isVisible (= old isDisabled(true) and Window::isEffectiveVisible (= old isVisible(false))
* WindowManager::loadWindowLayout is renamed to WindowManager::loadLayoutFromFile
* NamedXMLResourceManager::create is renamed to NamedXMLResourceManager::createFromFile (Ex. CEGUI::SchemeManager::createFromFile)
* CEGUI::DefaultLogger no longer throws const char* but a real exception in setLogFilename - http://www.cegui.org.uk/mantis/view.php?id=443
* CEGUI now has inbuilt copy, cut, paste support, if you used a custom solution, you might want to check CEGUI::Clipboard and System::inject{Copy,Cut,Paste}Request
* CEGUI::ProgressBar::getStep renamed to getStepSize for consistency with setStepSize
* CEGUI::WidgetLookManager::parseLookNFeelSpecification is now called parseLookNFeelSpecificationFromFile, variants for loading from string and raw data container have been added
* XRotation, YRotation, ZRotation properties merged into the new Rotation property, which is a Quaternion.
}}
{{Section|1=Property Name Changes|2=
* Property from Window called "ZOrderChangeEnabled" renamed to "ZOrderingEnabled"
* Property from Window called "MouseButtonDownAutoRepeat" renamed to "MouseAutoRepeatEnabled"
* Property from Window called "CustomTooltipType" renamed to "TooltipType"
* Property from Window called "Tooltip" renamed to "TooltipText"
* Property from Window called "RiseOnClick" renamed to "RiseOnClickEnabled"
* Property from Window called "UnifiedAreaRect" renamed to "Area", "UnifiedSize" renamed to "Size", etc...
* Property "MaxEditTextLength" renamed to "MaxTextLength"
}}
{{Section|1=Event Name Changes|2=
* EventMouseEnters renamed to EventMouseEntersSurface (old name removed)
* EventMouseLeaves renamed to EventMouseLeavesSurface (old name removed)
* CheckStateChanged renamed to SelectStateChanged (for ToggleButton (old Checkbox))
}}
{{Section|1=Image and ImageManager|2=
* Image::draw renamed to Image::render
* Image class is now an abstract interface. BasicImage implementation is provided, and used for internally created Image objects.
* Imageset class is removed. It remains a CEGUI format that allows to conveniently define multiple images on one texture but the data is no longer stored in any class. When Imageset is loaded, the ImageManager creates a new BasicImage for each of the images in the imageset. Only the images themselves will remain after imageset is loaded. You now use the new ImageManager to access defined images.
* ImagesetManager class is removed. You now use the new ImageManager.
* Images belonging to a certain imageset can be accessed like so: "ImageSetName/ImageName" (ex. "AlfiskoSkin/MouseArrow").
}}
{{Section|1=GUIContext|2=
A lot of API has been moved from CEGUI::System to CEGUI::GUIContext. CEGUI now allows you to create multiple independent GUI contexts with their own input injection.

As a rule of thumb, whenever you see "There is no CEGUI::System::some_foobar_method method", it is likely that you can replace the call with CEGUI::System::getSingleton().getDefaultGUIContext().someFoobarMethod(). This holds for all the System::inject* methods for example.

Exceptions from the rule:
* CEGUI::System::getSingleton().renderGUI() → CEGUI::System::getSingleton().renderAllGUIContexts()

WindowManager::getSingleton().getWindow() was removed. You can emulate its behaviour with root->getChild("Stuff/After/Root/Name").
To get Root Window you can call GUIContext::getRootWindow();

SIDE NOTE: The chain call of methods CEGUI::System::getSingleton().getDefaultGUIContext() should be called as rarely as possible, instead one should keep it's result in appropriate variable.

}}
{{Section|1=PyCEGUI|2=
* EventSet.subscribeEvent now has a different, more pythonic syntax, any python callable (bound member function, free function, lambda, functor, ...) is allowed (EventSet.subscribeEvent("EventName", instance, "someMethodInIt") is now EventSet.subscribeEvent("EventName", instance.someMethodInIt)
}}

{{Section|1=Datafiles|2=
* All XML datafiles must specify a version attribute. Example: <GUILayout '''version="4"'''>
* All attributes in datafiles must begin with a lower-case letter. Example: <Property '''n'''ame="Alpha" '''v'''alue="1.0" />
* See '''Property Name Changes''' and '''Event Name Changes''' above

* '''.looknfeel:'''
** <Falagard version="7">
** old: <Image '''type'''="TopEdge" '''imageset'''="TaharezLook" '''image'''="TitlebarTop" /> new: <Image '''component'''="TopEdge" '''name'''="TaharezLook/TitlebarTop" />
** Change: MaxEditTextLength → MaxTextLength
** Change: MouseButtonDownAutoRepeat → MouseAutoRepeatEnabled
** Change: DimOperator → OperatorDim. Please compare [http://static.cegui.org.uk/docs/0.7.9/fal_element_ref.html#fal_elem_ref_sec_10 0.7.9] with [http://static.cegui.org.uk/docs/current/fal_element_ref.html#fal_elem_ref_sec_operatordim latest] for functional change description
*** old formatting: VALUE1 { DIMOPERATOR() { VALUE2 } } new formatting: OPERATORDIM() { VALUE1, VALUE2 }
* '''.scheme:'''
** <GUIScheme name="MySkin" version="5">
** Change: <WindowRendererSet Filename="CEGUIFalagardWRBase" /> → <WindowRendererSet filename="CEGUICoreWindowRendererSet" />
** Change: renderer="Falagard/... → renderer="Core/...
** Change: "Core/SystemButton" → "Core/Button"
** Change: "CEGUI/Checkbox" → "CEGUI/ToggleButton"
* '''.layout:'''
** <GUILayout version="4">
** UnifiedPosition, UnifiedAreaRect, UnifiedSize, UnifiedMinSize, UnifiedMaxSize → Position, Area, Size, MinSize, MaxSize
** Tooltip → TooltipText
** old: <Property name="Image" value="set:Buttons image:Settings" /> new: <Property name="Image" value="Buttons/Settings" />
* '''.imageset:'''
** <Imageset version="2" ... />
* '''.font:'''
** 

* If you build your own version of ceed (see this guide - http://cegui.org.uk/wiki/Building_CEED_for_Windows), you can then use the ceed-migrate tool to automate and batch all of the changes discussed in this section. See here for a quick guide to using ceed-migrate - http://cegui.org.uk/wiki/Using_CEED-Migrate
}}
[[Category:Manuals]]

Animation System

2012-05-31T14:18:13Z

Kornerr: /* Via code */

{{VersionBadge|0.7}} {{VersionBadge|0.8}}
{{VersionAtLeast|0.7.2}}

== Prerequisites ==
'''You have to inject time pulses (see System::injectTimePulse), otherwise CEGUI has no idea time is passing and the animations will always be stuck at the position they started at.'''

== Basic concepts ==
In UI lots of animations are likely to be shared (for example widget specific animation), so CEGUI splits the animation between definition and instance. You can have one animation definition animating large amount of Windows, having only one animation per window is also fine (one animation with only one instance). Animation definitions aren't tied to window type, the only condition is that the target must have all affected (target properties of all affectors inside the animation) and source properties (all source properties in key frames, if any).

== Purpose of animation classes ==

=== Animation Definition (class {{DoxygenClass|Animation|0.7}}) ===
This class holds defining data for animations. Specifically duration, replay mode, auto start and list of Affectors. This class doesn't directly animate anything. You have to instantiate it via CEGUI::AnimationManager::instantiateAnimation.

=== Affector (class {{DoxygenClass|Affector|0.7}}) ===
Affector affects (changes the value of) one property. It holds application method (more about that later), target property, used interpolator and list of key frames.

=== Key Frame (class {{DoxygenClass|KeyFrame|0.7}}) ===
Key frame represents the value of affected property at given time position. It holds value, source property and time position. Key frames can use values of properties of the affected window. If source property is not empty, property is saved when animation starts and used as value for this key frame.

=== Animation Instance (class {{DoxygenClass|AnimationInstance|0.7}}) ===
This class uses animation definition to animate Window. It holds animation position and playback speed.

=== Animation Manager (class {{DoxygenClass|AnimationManager|0.7}}) ===
Singleton class. You use it to create new animation definitions and instantiate existing animation definitions. (You should not construct Animation definitions or Animation instances directly, always use Animation Manager).

=== Interpolator (class {{DoxygenClass|Interpolator|0.7}}) ===
To be able to animate smoothly between 2 discrete keyframes, interpolators had to be introduced. You don't have to use them directly, everything is done for you in the animation classes. You only need to understand their internals if you need custom interpolator (as all basic interpolators are included in CEGUI, if you find some property that can't be animated with stock interpolators, let us know).

== Defining animations ==

=== Via code ===
This sample animation takes 0.3 seconds and in that time, it fades the window and rotates it 10 degrees around Y axis.
<source lang="cpp">
{
CEGUI::Animation* anim = CEGUI::AnimationManager::getSingleton().createAnimation("Testing");
anim->setDuration(0.3f); // duration in seconds
anim->setReplayMode(CEGUI::Animation::RM_Once); // when this animation is started, only play it once, then stop

// now we define affector inside our Testing animation
{
// this affector changes YRotation and interpolates keyframes with float interpolator
CEGUI::Affector* affector = anim->createAffector("YRotation", "float");
// at 0.0 seconds, the animation should set YRotation to 0 degrees
affector->createKeyFrame(0.0f, "0.0");
// at 0.3 seconds, YRotation should be 10.0 degrees and animation should progress towards this in an accelerating manner
affector->createKeyFrame(0.3f, "10.0", CEGUI::KeyFrame::P_QuadraticAccelerating);
}

// animation can have more than one affectors! lets define another affector that changes Alpha
{
// this affector will again use float interpolator
CEGUI::Affector* affector = anim->createAffector("Alpha", "float");
affector->createKeyFrame(0.0f, "1.0"); // at 0.0 seconds, set alpha to 1.0
affector->createKeyFrame(0.3f, "0.5", CEGUI::KeyFrame::P_QuadraticDecelerating); // at 0.3 seconds, set alpha to 0.5, now decelerating!
}
}
</source>

=== Via [[Falagard]] looknfeel XML ===
<source lang="xml">
<WidgetLook ...>
...
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" />
</Affector>
<Affector property="YRotation" interpolator="float">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</WidgetLook>
</source>

Animating colours example, with [http://www.cegui.org.uk/docs/current/xml_animation.html#xml_animation_keyframe KeyFrame sourceProperty] and the colour [http://www.cegui.org.uk/docs/current/xml_animation.html#xml_animation_affector interpolator]:
<source lang="xml">
<AnimationDefinition name="NormalToHover" duration="0.2" replayMode="once">
<Affector property="CurrentColour" interpolator="colour">
<KeyFrame position="0.0" sourceProperty="NormalColour" />
<KeyFrame position="0.2" sourceProperty="HoverColour" />
</Affector>
</AnimationDefinition>
</source>

=== Via separate animation list XML (AnimationManager::loadAnimationsFromXML) ===
<source lang="xml">
<Animations>
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" />
</Affector>
<Affector property="YRotation" interpolator="float">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</Animations>
</source>

== Instantiating animations ==
If you created the animation in code or via separate animation definition file, you have to instantiate it (only [[Falagard]] instantiates and sets target automatically).

<source lang="cpp">
CEGUI::AnimationInstance* instance = CEGUI::AnimationManager::getSingleton().instantiateAnimation(anim);
// after we instantiate the animation, we have to set its target window
instance->setTargetWindow(targetWindow);

// at this point, you can start this instance and see the results
instance->start();
</source>

== Connecting events and animations ==
You often want your animation to start when something happens (Mouse gets over the widget, new FrameWindow is opened, etc). You have two options to achieve this.

If you already are using XML to define animations, the easiest solution is to use the auto event subscription facility. You add pairs of Event name and action that should happen with the animation ("Start", "Stop", "Pause", "Unpause", etc.) and when target window is set, these subscriptions are automatically made for your convenienve.

Both [[Falagard]] and Animations.xml approaches are the same with regards to this. This XML snippet starts the animation when mouse enters the target window's area.
<source lang="xml">
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
...
<Subscription event="MouseEntersArea" action="Start" />
</AnimationDefinition>
</source>

Doing this in code is much more powerful (you can subscribe to a window that's different than target window) but also more messy:
<source lang="cpp">
windowWithEvent->subscribeEvent(CEGUI::Window::EventMouseEntersArea, CEGUI::Event::Subscriber(&CEGUI::AnimationInstance::handleStart, instance));
</source>

You can also do this from a Lua script:
<source lang="lua">
CEGUI.WindowManager:getSingleton():getWindow("WindowName"):subscribeEvent("MouseEnter", "luafunctionname")
</source>
This code sets up the window specified in WindowName, the name of that window on creation or from the XML "Name" property, to react to the mouse entering it by calling the Lua function specified in luafunctionname. The Lua function name argument should be the name, without trailing (), to a function declared in Lua or exported to Lua from C.

== Progression ==
As I created the implementation, I noticed that linear animations look really boring and predictable. Often times accelerating or decelerating anims will look much better and lively. To make creating those easier, I introduced progression to key frames. This enum tells the system how to progress towards the key frame that holds the progression (that means progression on the first key frame is never used!). The default is linear, meaning that progress towards the keyframe is completely linear. Try the other options yourself to see the differences.
=== animations.xml example ===
Here we have edited the example animation so that the alpha value uses the quadratic deceleration progression. This will make the alpha value drop quickly in the first frames but the speed of the change will decrease quickly and give a smooth finish to the transition.
<source lang="xml">
<Animations>
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" progression="quadratic decelerating" />
</Affector>
<Affector property="YRotation" interpolator="float">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</Animations>
</source>
Possible values for this property, in XML, are:
* "linear": (default value) Simple linear transition. Same rate of progression for every frame.
* "discrete": Abrupt progression, goes from one value straight to the next one.
* "quadratic accelerating": Starts slow but accelerates to very fast towards the end.
* "quadratic decelerating": Starts very fast but comes smoothly to a halt in the end.

== Application methods ==
Affectors offer 3 different "application methods". One is absolute, meaning that the keyframe value is taken as absolute and is directly set to the property after interpolation. The other 2 are relative. That means that when the animation starts, the old values of properties are saved and later used when animating. AM_Relative means saved_value + interpolated_value, AM_RelativeMultiply means saved_value * interpolated_float.

=== animations.xml example: ===
In the following example we have changed the rotation affector to do relative rotation instead of absolute, which is default. This means that whatever rotation the window had when the animation started it will add the new rotation to that value. The absolute method would have reset the rotation to 0 in the first key frame and then proceeded to rotate it by 10 degrees during 0.3 seconds.
<source lang="xml">
<Animations>
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" />
</Affector>
<Affector property="YRotation" interpolator="float" applicationMethod="relative">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</Animations>
</source>
Possible values for this property, in XML, are:
* "absolute": (default setting) The interpolated value is set as the new property value.
* "relative": The interpolated value is added to the starting value of the property.
* "relative multiply": The interpolated value is multiplied with the starting value of the property.

[[Category:Manuals]]

Animation System

2012-05-31T14:17:29Z

Kornerr: /* Via code */

{{VersionBadge|0.7}} {{VersionBadge|0.8}}
{{VersionAtLeast|0.7.2}}

== Prerequisites ==
'''You have to inject time pulses (see System::injectTimePulse), otherwise CEGUI has no idea time is passing and the animations will always be stuck at the position they started at.'''

== Basic concepts ==
In UI lots of animations are likely to be shared (for example widget specific animation), so CEGUI splits the animation between definition and instance. You can have one animation definition animating large amount of Windows, having only one animation per window is also fine (one animation with only one instance). Animation definitions aren't tied to window type, the only condition is that the target must have all affected (target properties of all affectors inside the animation) and source properties (all source properties in key frames, if any).

== Purpose of animation classes ==

=== Animation Definition (class {{DoxygenClass|Animation|0.7}}) ===
This class holds defining data for animations. Specifically duration, replay mode, auto start and list of Affectors. This class doesn't directly animate anything. You have to instantiate it via CEGUI::AnimationManager::instantiateAnimation.

=== Affector (class {{DoxygenClass|Affector|0.7}}) ===
Affector affects (changes the value of) one property. It holds application method (more about that later), target property, used interpolator and list of key frames.

=== Key Frame (class {{DoxygenClass|KeyFrame|0.7}}) ===
Key frame represents the value of affected property at given time position. It holds value, source property and time position. Key frames can use values of properties of the affected window. If source property is not empty, property is saved when animation starts and used as value for this key frame.

=== Animation Instance (class {{DoxygenClass|AnimationInstance|0.7}}) ===
This class uses animation definition to animate Window. It holds animation position and playback speed.

=== Animation Manager (class {{DoxygenClass|AnimationManager|0.7}}) ===
Singleton class. You use it to create new animation definitions and instantiate existing animation definitions. (You should not construct Animation definitions or Animation instances directly, always use Animation Manager).

=== Interpolator (class {{DoxygenClass|Interpolator|0.7}}) ===
To be able to animate smoothly between 2 discrete keyframes, interpolators had to be introduced. You don't have to use them directly, everything is done for you in the animation classes. You only need to understand their internals if you need custom interpolator (as all basic interpolators are included in CEGUI, if you find some property that can't be animated with stock interpolators, let us know).

== Defining animations ==

=== Via code ===
This sample animation takes 0.3 seconds and in that time, it fades the window and rotates it 10 degrees around Y axis.
<source lang="cpp">
{
CEGUI::Animation* anim = CEGUI::AnimationManager::getSingleton().createAnimation("Testing");
anim->setDuration(0.3f); // duration in seconds
anim->setReplayMode(CEGUI::Animation::RM_Once); // when this animation is started, only play it once, then stop

// now we define affector inside our Testing animation
{
// this affector changes YRotation and interpolates keyframes with float interpolator
CEGUI::Affector* affector = anim->createAffector("YRotation", "float");
// at 0.0 seconds, the animation should set YRotation to 0 degrees
affector->createKeyFrame(0.0f, "0.0");
// at 0.3 seconds, YRotation should be 10.0 degrees and animation should progress towards this in an accelerating manner
affector->createKeyFrame(0.3f, "10.0", CEGUI::KeyFrame::P_QuadraticAccelerating);
}

// animation can have more than one affectors! lets define another affector that changes Alpha
{
// this affector will again use float interpolator
CEGUI::Affector* affector = anim->createAffector("Alpha", "float");
affector->createKeyFrame(0.0f, "1.0"); // at 0.0 seconds, set alpha to 1.0
affector->createKeyFrame(0.3f, "0.5", CEGUI::KeyFrame::P_QuadraticDecelerating); // at 1.0 seconds, set alpha to 0.5, now decelerating!
}
}
</source>

=== Via [[Falagard]] looknfeel XML ===
<source lang="xml">
<WidgetLook ...>
...
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" />
</Affector>
<Affector property="YRotation" interpolator="float">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</WidgetLook>
</source>

Animating colours example, with [http://www.cegui.org.uk/docs/current/xml_animation.html#xml_animation_keyframe KeyFrame sourceProperty] and the colour [http://www.cegui.org.uk/docs/current/xml_animation.html#xml_animation_affector interpolator]:
<source lang="xml">
<AnimationDefinition name="NormalToHover" duration="0.2" replayMode="once">
<Affector property="CurrentColour" interpolator="colour">
<KeyFrame position="0.0" sourceProperty="NormalColour" />
<KeyFrame position="0.2" sourceProperty="HoverColour" />
</Affector>
</AnimationDefinition>
</source>

=== Via separate animation list XML (AnimationManager::loadAnimationsFromXML) ===
<source lang="xml">
<Animations>
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" />
</Affector>
<Affector property="YRotation" interpolator="float">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</Animations>
</source>

== Instantiating animations ==
If you created the animation in code or via separate animation definition file, you have to instantiate it (only [[Falagard]] instantiates and sets target automatically).

<source lang="cpp">
CEGUI::AnimationInstance* instance = CEGUI::AnimationManager::getSingleton().instantiateAnimation(anim);
// after we instantiate the animation, we have to set its target window
instance->setTargetWindow(targetWindow);

// at this point, you can start this instance and see the results
instance->start();
</source>

== Connecting events and animations ==
You often want your animation to start when something happens (Mouse gets over the widget, new FrameWindow is opened, etc). You have two options to achieve this.

If you already are using XML to define animations, the easiest solution is to use the auto event subscription facility. You add pairs of Event name and action that should happen with the animation ("Start", "Stop", "Pause", "Unpause", etc.) and when target window is set, these subscriptions are automatically made for your convenienve.

Both [[Falagard]] and Animations.xml approaches are the same with regards to this. This XML snippet starts the animation when mouse enters the target window's area.
<source lang="xml">
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
...
<Subscription event="MouseEntersArea" action="Start" />
</AnimationDefinition>
</source>

Doing this in code is much more powerful (you can subscribe to a window that's different than target window) but also more messy:
<source lang="cpp">
windowWithEvent->subscribeEvent(CEGUI::Window::EventMouseEntersArea, CEGUI::Event::Subscriber(&CEGUI::AnimationInstance::handleStart, instance));
</source>

You can also do this from a Lua script:
<source lang="lua">
CEGUI.WindowManager:getSingleton():getWindow("WindowName"):subscribeEvent("MouseEnter", "luafunctionname")
</source>
This code sets up the window specified in WindowName, the name of that window on creation or from the XML "Name" property, to react to the mouse entering it by calling the Lua function specified in luafunctionname. The Lua function name argument should be the name, without trailing (), to a function declared in Lua or exported to Lua from C.

== Progression ==
As I created the implementation, I noticed that linear animations look really boring and predictable. Often times accelerating or decelerating anims will look much better and lively. To make creating those easier, I introduced progression to key frames. This enum tells the system how to progress towards the key frame that holds the progression (that means progression on the first key frame is never used!). The default is linear, meaning that progress towards the keyframe is completely linear. Try the other options yourself to see the differences.
=== animations.xml example ===
Here we have edited the example animation so that the alpha value uses the quadratic deceleration progression. This will make the alpha value drop quickly in the first frames but the speed of the change will decrease quickly and give a smooth finish to the transition.
<source lang="xml">
<Animations>
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" progression="quadratic decelerating" />
</Affector>
<Affector property="YRotation" interpolator="float">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</Animations>
</source>
Possible values for this property, in XML, are:
* "linear": (default value) Simple linear transition. Same rate of progression for every frame.
* "discrete": Abrupt progression, goes from one value straight to the next one.
* "quadratic accelerating": Starts slow but accelerates to very fast towards the end.
* "quadratic decelerating": Starts very fast but comes smoothly to a halt in the end.

== Application methods ==
Affectors offer 3 different "application methods". One is absolute, meaning that the keyframe value is taken as absolute and is directly set to the property after interpolation. The other 2 are relative. That means that when the animation starts, the old values of properties are saved and later used when animating. AM_Relative means saved_value + interpolated_value, AM_RelativeMultiply means saved_value * interpolated_float.

=== animations.xml example: ===
In the following example we have changed the rotation affector to do relative rotation instead of absolute, which is default. This means that whatever rotation the window had when the animation started it will add the new rotation to that value. The absolute method would have reset the rotation to 0 in the first key frame and then proceeded to rotate it by 10 degrees during 0.3 seconds.
<source lang="xml">
<Animations>
<AnimationDefinition name="Testing" duration="0.3" replayMode="once">
<Affector property="Alpha" interpolator="float">
<KeyFrame position="0.0" value="1.0" />
<KeyFrame position="0.3" value="0.5" />
</Affector>
<Affector property="YRotation" interpolator="float" applicationMethod="relative">
<KeyFrame position="0.0" value="0" />
<KeyFrame position="0.3" value="10" />
</Affector>
</AnimationDefinition>
</Animations>
</source>
Possible values for this property, in XML, are:
* "absolute": (default setting) The interpolated value is set as the new property value.
* "relative": The interpolated value is added to the starting value of the property.
* "relative multiply": The interpolated value is multiplied with the starting value of the property.

[[Category:Manuals]]

GSoC Ideas

2012-02-19T14:34:03Z

Kornerr: /* Revamp Ogre Renderer to be more high level */

IMPORTANT: Nothing is final, CEGUI might or might not get into GSoC! Feel free to add ideas though! :)
IMPORTANT2: I have arbitrarily chosen the mentors, mentors please add (ack) if you agree with my choice. Edit yourself out otherwise. Thanks!

== Samples framework ==
Currently, samples are separate applications that are run separately. It would be nice to have some sort of a unified framework for defining samples. That way you can start CEGUIDemos executable and browse through samples, switching them, etc... New samples should be coded in C++, Python or Lua (all languages CEGUI officially supports), so this framework should have bindings for Python and Lua. The GUI for choosing samples should of course be done with CEGUI.

Ogre has a similar sample framework (but samples can only be written in C++).

Part of this task is to create new demos, improve existing ones or possibly remove them if they don't make sense anymore.

difficulty: Medium

mentors: Jamarr, fusion44 (ack), Kulik (ack)

== New Font API ==
CEGUI exposes a lot of pain regarding text rendering and realtime 3D graphics to the user. You have to explicitly instantiate the font in sizes you will want, you have to instantiate bold, italic, etc variants as separate fonts, ... This task would involve changing the API around to make it simpler for the user. You would be able to define a Font you want to use and sizes would be loaded into textures dynamically (including garbage collection).

freetype2 and/or fonts vs OpenGL/DX experience would be very valuable for this task

difficulty: Medium

mentors: Jamarr, Kulik (ack)

== Revamp Ogre Renderer to be more high level ==
CEGUIOgreRenderer uses some intimate Ogre internals knowledge, we use lowlevel _ prefixed methods to draw. This is suboptimal for various reasons, the renderer is prone to Ogre changes that normally don't affect users. Render targets behave odd in OpenGL, DX10 and DX11 is somewhat supported in Ogre but CEGUI renders with various quirks with it, etc...

The idea is to use high level Ogre constructs to render, ManualObject as GeometryBuffer, Materials instead of manually altering the state via Ogre::RenderTarget, etc... All of this has to have comparable performance to the old Ogre Renderer.

difficulty: Medium

mentors: Jamarr, fusion44 (ack), Kulik (ack), kornerr (ack)

== Animation staging ==
Animation in CEGUI only works on a single window. It would be great if users were able to stage complex animations (think main menu appearing). The idea is to fire off multiple animations on a whole widget tree at the right times. This task also involves writing an editor in the CEGUI Unified Editor for it. The API should be rather simple and easy to do, the editor will be harder (IMO). You will be able to reuse timeline and other components from CEED for the editor.

difficulty: Medium

mentors: Jamarr, fusion44 (ack), Kulik (ack)

== LookNFeel editor for CEED ==
As of now, CEED edits layouts, imagesets and animations. LookNFeel editor would be a killer addition. Basically would allow artists to create new skins without touching XML code. This has always been a feature that many requested.

difficulty: Hard

mentors: Kulik (ack)

== Focus implementation ==
There's no focus implementation so far in CEGUI, i.e., you can't have both mouse and keyboard focuses. Only one widget has focus, and gets all inputs. This complicates game development and decreases GUI flexibility.
More info: http://www.cegui.org.uk/mantis/print_bug_page.php?bug_id=113

difficulty: Hard

mentors: kornerr (ack)

== Canvas (custom render independent drawing) + SVG subset ==
CEGUI only draws rectangles at this point (it binds textures to them but they are still rectangles). This task would be about adding the ability to draw other shapes to surfaces of widgets. The API should reuse concepts from other libraries.
It would be cool if we were able to draw a subset of SVG with this API (preferably having a subclass of Image called SVGImage). Implementing a CEGUI [http://code.google.com/p/skia Skia] renderer would help greatly with that.

difficulty: Hard

mentors: Jamarr, Kulik (ack)

GSoC Ideas

2012-01-09T11:27:29Z

Kornerr:

IMPORTANT: Nothing is final, CEGUI might or might not get into GSoC! Feel free to add ideas though! :)
IMPORTANT2: I have arbitrarily chosen the mentors, mentors please add (ack) if you agree with my choice. Edit yourself out otherwise. Thanks!

== Samples framework ==
Currently, samples are separate applications that are run separately. It would be nice to have some sort of an unified framework for defining samples. That way you can start CEGUIDemos executable and browse through samples, switching them, etc... New samples should be coded in C++, Python or Lua (all languages CEGUI officially supports), so this framework should have bindings for Python and Lua. The GUI for choosing samples should of course be done with CEGUI.

Ogre has a similar sample framework (but samples can only be written in C++).

difficulty: Easy

mentors: Jamarr, fusion44, Kulik (ack)

== New Font API ==
CEGUI exposes a lot of pain regarding text rendering and realtime 3D graphics to the user. You have to explicitly instantiate the font in sizes you will want, you have to instantiate bold, italic, etc variants as separate fonts, ... This task would involve changing the API around to make it simpler for the user. You would be able to define a Font you want to use and sizes would be loaded into textures dynamically (including garbage collection).

freetype2 and/or fonts vs OpenGL/DX experience would be very valuable for this task

difficulty: Medium

mentors: Jamarr, fusion44, Kulik (ack)

== Revamp Ogre Renderer to be more high level ==
CEGUIOgreRenderer uses some intimate Ogre internals knowledge, we use lowlevel _ prefixed methods to draw. This is suboptimal for various reasons, the renderer is prone to Ogre changes that normally don't affect users. Render targets behave odd in OpenGL, DX10 and DX11 is somewhat supported in Ogre but CEGUI renders with various quirks with it, etc...

The idea is to use high level Ogre constructs to render, ManualObject as GeometryBuffer, Materials instead of manually altering the state via Ogre::RenderTarget, etc... All of this has to have comparable performance to the old Ogre Renderer.

difficulty: Medium

mentors: Jamarr, fusion44, Kulik (ack)

== Animation staging ==
Animation in CEGUI only works on a single window. It would be great if users were able to stage complex animations (think main menu appearing). The idea is to fire off multiple animations on a whole widget tree at the right times. This task also involves writing an editor in the CEGUI Unified Editor for it. The API should be rather simple and easy to do, the editor will be harder (IMO).

difficulty: Medium

mentors: Jamarr, fusion44, Kulik (ack)

== LookNFeel editor for CEED ==
As of now, CEED edits layouts, imagesets and animations. LookNFeel editor would be a killer addition. Basically would allow artists to create new skins without touching XML code. This has always been a feature that many requested.

difficulty: Hard

mentors: Kulik (ack)

== Focus implementation ==
There's no focus implementation so far in CEGUI, i.e., you can't have both mouse and keyboard focuses. Only one widget has focus, and gets all inputs. This complicates game development and decreases GUI flexibility.
More info: http://www.cegui.org.uk/mantis/print_bug_page.php?bug_id=113

difficulty: Hard

mentors: kornerr (ack)

CEED

2011-09-27T12:08:43Z

Kornerr: /* Notes */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

=== Imagesets ===

[[Image:Ceed_imageset.png]]

To create a new image, press tool bar button second from the right, or click with the right mouse button on the image itself and select '''Create image''':

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Move and resize it as you see fit.

== Settings ==
Go to '''Edit -> Application settings'''.

[[Image:Ceed_application_settings.png]]

There are many settings you can tweak. One of the most important might be '''Shortcuts'''. It allows you to assign shortcuts to zoom, image creation, opening a project, and so on.

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

File:Ceed application settings.png

2011-09-27T12:06:39Z

Kornerr:

CEED

2011-09-27T12:02:23Z

Kornerr: /* Imagesets */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

=== Imagesets ===

[[Image:Ceed_imageset.png]]

To create a new image, press tool bar button second from the right, or click with the right mouse button on the image itself and select '''Create image''':

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Move and resize it as you see fit.

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

CEED

2011-09-27T12:01:51Z

Kornerr: /* Imagesets */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

== Imagesets ==

[[Image:Ceed_imageset.png]]

To create a new image, press tool bar button second from the right, or click with the right mouse button on the image itself and select '''Create image''':

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Move and resize it as you see fit.

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

CEED

2011-09-27T11:59:47Z

Kornerr: /* Layouts */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

== Imagesets ==

[[Image:Ceed_imageset.png]]

To create a new image, press second from the left button on the tool bar, or click with the right mouse button on the image itself and select "Create image":

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Adjust it.

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

File:Ceed imageset create image.png

2011-09-27T11:57:37Z

Kornerr:

File:Ceed imageset.png

2011-09-27T11:53:41Z

Kornerr:

CEED

2011-09-26T15:16:54Z

Kornerr: /* Project resources */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

CONTINUE HERE

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

CEED

2011-09-26T15:14:55Z

Kornerr: /* Project settings */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts.

=== Layouts ===

[[Image:Ceed_layout.png]]

CONTINUE HERE

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

File:Ceed layout.png

2011-09-26T15:14:18Z

Kornerr:

File:Ceed project add existing.png

2011-09-26T15:03:26Z

Kornerr:

CEED

2011-09-26T14:51:34Z

Kornerr:

CEED

2011-09-26T14:20:07Z

Kornerr: /* Project */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', a warning appears:

[[Image:Ceed_new_project_warning.png]]

When you press '''OK''', CEED sets up the paths to usual CEGUI resource directories. It suggests that the directory with ".project" file contains "animations", "fonts", and other CEGUI directories. If you got the above warning, your directory does not contain the necessary "scheme" directory. We will specify correct paths later.

== Project settings ==

Go to Edit -> Project settings.

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "scheme" and the rest directories are located, then press "Apply". It will change the paths below.

Press OK and it might load your resources. It failed for me [CONTINUE HERE]

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

CEED

2011-09-26T14:15:36Z

Kornerr: /* Dependencies */

Upcoming CEGUI unified editor. Currently in the early stages. Includes project management and multi-file/multi-tab editing.

== Install ==

CEED depends on an yet unreleased CEGUI 0.8, so you will need to set up a special environment to run it.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums]

=== Dependencies ===

You need CMake, Python >= 2.6, PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

=== Build CEGUI and PyCEGUI ===

mkdir -p cegui_mk2/build
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/cegui_mk2 cegui_mk2/cegui
hg clone http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
cd cegui_mk2/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON ../cegui
make

== Launch ==

cd CEED
./runwrapper.sh
python CEED.py

You will see a window like this:

[[Image:Ceed_main_window.png]]

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to File -> New project.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press OK, a warning appears:

[[Image:Ceed_new_project_warning.png]]

When you press OK, CEED sets up the paths to usual CEGUI resource directories. It suggests that the directory with ".project" file contains "animations", "fonts", and other CEGUI directories. If you got the above warning, your directory does not contain the necessary "scheme" directory. We will specify correct paths later.

== Project settings ==

Go to Edit -> Project settings.

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "scheme" and the rest directories are located, then press "Apply". It will change the paths below.

Press OK and it might load your resources. It failed for me [CONTINUE HERE]

== Notes ==

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

Contribution

2011-09-26T14:11:45Z

Kornerr:

The article describes how you can contribute to a CEGUI project with the help of [http://bitbucket.org BitBucket].

We prefer your contribution through BitBucket, because it simplifies the development process for both you and us. If your contribution needs a bit more tuning, we just say so and you make another commit to your BitBucket repository. After we are satisfied with the quality of the fixes, we simply pull them from you repository. And since your repository is located under your nickname, we will know you can be trusted. So it's a win-win for everybody.

If you prefer video tutorials, you can [http://www.youtube.com/watch?v=ZjFOvLGnAiU watch this tutorial].

'''Note''': This tutorial describes contribution to [[CEED]] (CEGUI Editor) as a user '''kornerr''' as an example.

== Import CEED repository to BitBucket ==

Go to [https://bitbucket.org/repo/import Repositories -> import repository].

Input the following:
{| class="wikitable"
| Source
| Mercurial repository
|-
| URL
| http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
|-
| Requires authorization
| No
|-
| Name
| CEED
|-
| Private
| No
|-
| Language
| Python (CEGUI itself is C++)
|-
| Description
| CEED contribution
|-
| Website
| Leave blank
|-
| Wiki
| Leave blank
|-
| Issue tracking
| Leave blank
|}

Press '''Import'''.

BitBucket will import the repository:

[[Image:Ceed_contrib_import_repo.png]]

Wait a bit, and you're done:

[[Image:Ceed contrib import repo done.png]]

== Clone from BitBucket to your machine ==
cd ~
hg clone https://bitbucket.org/kornerr/ceed

This will clone CEED repository from BitBucket to your home directory.

== Make changes, commit, and push ==

Make changes. Mine were:
diff --git a/compatibility/looknfeel/cegui.py b/compatibility/looknfeel/cegui.py
--- a/compatibility/looknfeel/cegui.py
+++ b/compatibility/looknfeel/cegui.py
@@ -95,6 +95,9 @@
log = ""

root = ElementTree.fromstring(data)
+ # Fix for Python < 2.7.
+ if not hasattr(root, "iter"):
+ root.iter = root.getiterator

# version 7 has a version attribute
root.set("version", "7")

Commit with a meaningful message, e.g., in my case it was:
hg commit -m "XML iterator fix for Python < 2.7. tested on Python 2.6"

And push it back to BitBucket:
kornerr@koren:~/ceed$ '''hg push'''
pushing to https://bitbucket.org/kornerr/ceed
searching for changes
http authorization equired
realm: Bitbucket.org HTTP
user: '''kornerr'''
password:
remote: adding changesets
remote: adding manifests
remote: adding file changes
remote: added 1 changesets with 1 changes to 1 files
remote: bb/acl: kornerr is allowed. accepted payload.

You can see your changes at BitBucket now:

[[Image:Ceed_contrib_push.png]]

'''Note: Please, don't try to merge many fixes into single commit. Place each fix into its own commit. It will be easier for us to understand your fixes and accept it faster.'''

== Contact CEGUI developer(s) ==
Use IRC, mail, or mantis. Tell the URL of your repository and list the changesets you want into upstream.

== Further contributions ==
If you will contribute again later, you need to first update your BitBucket repository to upstream version, and only then make changes. Please, do it, otherwise your fixes may be rejected simply because we can't spend hours in figuring out how to apply your old changes to the latest version.

To update your BitBucket repository to upstream version, go to your clone of BitBucket repository on your machine and do:
hg pull -u http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED

Then simply push the changes back to your BitBucket repository:
hg push

Contribution

2011-09-26T12:57:19Z

Kornerr: /* 3. Make changes, commit, and push */

The article describes how you can contribute to a CEGUI project with the help of [http://bitbucket.org BitBucket].

We prefer your contribution through BitBucket, because it simplifies the development process for both you and us. If your contribution needs a bit more tuning, we just say so and you make another commit to your BitBucket repository. After we are satisfied with the quality of the fixes, we simply pull them from you repository. And since your repository is located under your nickname, we will know you can be trusted. So it's a win-win for everybody.

If you prefer video tutorials, you can [http://www.youtube.com/watch?v=ZjFOvLGnAiU watch this tutorial].

'''Note''': This tutorial describes contribution to [[CEED]] (CEGUI Editor) as a user '''kornerr''' as an example.

== 1. Import CEED repository to BitBucket ==

Go to [https://bitbucket.org/repo/import Repositories -> import repository].

Input the following:
{| class="wikitable"
| Source
| Mercurial repository
|-
| URL
| http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
|-
| Requires authorization
| No
|-
| Name
| CEED
|-
| Private
| No
|-
| Language
| Python (CEGUI itself is C++)
|-
| Description
| CEED contribution
|-
| Website
| Leave blank
|-
| Wiki
| Leave blank
|-
| Issue tracking
| Leave blank
|}

Press '''Import'''.

BitBucket will import the repository:

[[Image:Ceed_contrib_import_repo.png]]

Wait a bit, and you're done:

[[Image:Ceed contrib import repo done.png]]

== 2. Clone from BitBucket to your machine ==
cd ~
hg clone https://bitbucket.org/kornerr/ceed

This will clone CEED repository from BitBucket to your home directory.

== 3. Make changes, commit, and push ==

Make changes. Mine were:
diff --git a/compatibility/looknfeel/cegui.py b/compatibility/looknfeel/cegui.py
--- a/compatibility/looknfeel/cegui.py
+++ b/compatibility/looknfeel/cegui.py
@@ -95,6 +95,9 @@
log = ""

root = ElementTree.fromstring(data)
+ # Fix for Python < 2.7.
+ if not hasattr(root, "iter"):
+ root.iter = root.getiterator

# version 7 has a version attribute
root.set("version", "7")

Commit with a meaningful message, e.g., in my case it was:
hg commit -m "XML iterator fix for Python < 2.7. tested on Python 2.6"

And push it back to BitBucket:
kornerr@koren:~/ceed$ '''hg push'''
pushing to https://bitbucket.org/kornerr/ceed
searching for changes
http authorization equired
realm: Bitbucket.org HTTP
user: '''kornerr'''
password:
remote: adding changesets
remote: adding manifests
remote: adding file changes
remote: added 1 changesets with 1 changes to 1 files
remote: bb/acl: kornerr is allowed. accepted payload.

You can see your changes at BitBucket now:

[[Image:Ceed_contrib_push.png]]

'''Note: Please, don't try to merge many fixes into single commit. Place each fix into its own commit. It will be easier for us to understand your fixes and accept it faster.'''

== 4. Contact CEGUI developer(s) ==
Use IRC, mail, or mantis. Tell the URL of your repository and list the changesets you want into upstream.

Contribution

2011-09-26T12:39:31Z

Kornerr:

The article describes how you can contribute to a CEGUI project with the help of [http://bitbucket.org BitBucket].

We prefer your contribution through BitBucket, because it simplifies the development process for both you and us. If your contribution needs a bit more tuning, we just say so and you make another commit to your BitBucket repository. After we are satisfied with the quality of the fixes, we simply pull them from you repository. And since your repository is located under your nickname, we will know you can be trusted. So it's a win-win for everybody.

If you prefer video tutorials, you can [http://www.youtube.com/watch?v=ZjFOvLGnAiU watch this tutorial].

'''Note''': This tutorial describes contribution to [[CEED]] (CEGUI Editor) as a user '''kornerr''' as an example.

== 1. Import CEED repository to BitBucket ==

Go to [https://bitbucket.org/repo/import Repositories -> import repository].

Input the following:
{| class="wikitable"
| Source
| Mercurial repository
|-
| URL
| http://crayzedsgui.hg.sourceforge.net/hgroot/crayzedsgui/CEED
|-
| Requires authorization
| No
|-
| Name
| CEED
|-
| Private
| No
|-
| Language
| Python (CEGUI itself is C++)
|-
| Description
| CEED contribution
|-
| Website
| Leave blank
|-
| Wiki
| Leave blank
|-
| Issue tracking
| Leave blank
|}

Press '''Import'''.

BitBucket will import the repository:

[[Image:Ceed_contrib_import_repo.png]]

Wait a bit, and you're done:

[[Image:Ceed contrib import repo done.png]]

== 2. Clone from BitBucket to your machine ==
cd ~
hg clone https://bitbucket.org/kornerr/ceed

This will clone CEED repository from BitBucket to your home directory.

== 3. Make changes, commit, and push ==

Make changes. Mine were:
diff --git a/compatibility/looknfeel/cegui.py b/compatibility/looknfeel/cegui.py
--- a/compatibility/looknfeel/cegui.py
+++ b/compatibility/looknfeel/cegui.py
@@ -95,6 +95,9 @@
log = ""

root = ElementTree.fromstring(data)
+ # Fix for Python < 2.7.
+ if not hasattr(root, "iter"):
+ root.iter = root.getiterator

# version 7 has a version attribute
root.set("version", "7")

Commit with a meaningful message, e.g., in my case it was:
hg commit -m "XML iterator fix for Python < 2.7. tested on Python 2.6"

And push it back to BitBucket:
kornerr@koren:~/ceed$ '''hg push'''
pushing to https://bitbucket.org/kornerr/ceed
searching for changes
http authorization equired
realm: Bitbucket.org HTTP
user: '''kornerr'''
password:
remote: adding changesets
remote: adding manifests
remote: adding file changes
remote: added 1 changesets with 1 changes to 1 files
remote: bb/acl: kornerr is allowed. accepted payload.

You can see your changes at BitBucket now:

[[Image:Ceed_contrib_push.png]]

File:Ceed contrib push.png

2011-09-26T12:38:20Z

Kornerr:

Contribution

2011-09-25T12:23:20Z

Kornerr: Created page with "The article describes how you can contribute to a CEGUI project with the help of [http://bitbucket.org BitBucket]. We prefer your contribution through BitBucket, because it simp..."

File:Ceed contrib import repo done.png

2011-09-25T12:21:42Z

Kornerr: uploaded a new version of "File:Ceed contrib import repo done.png"

File:Ceed contrib import repo done.png

2011-09-25T12:19:42Z

Kornerr:

File:Ceed contrib import repo.png

2011-09-25T12:17:28Z

Kornerr:

CEED

2011-09-23T15:46:45Z

Kornerr:

File:Ceed project settings.png

2011-09-23T15:38:49Z

Kornerr:

File:Ceed new project warning.png

2011-09-23T15:30:49Z

Kornerr:

File:Ceed new project.png

2011-09-23T15:28:12Z

Kornerr: uploaded a new version of "File:Ceed new project.png"

File:Ceed new project.png

2011-09-23T15:24:33Z

Kornerr:

File:Ceed main window.png

2011-09-23T15:22:36Z

Kornerr: uploaded a new version of "File:Ceed main window.png"

File:Ceed main window.png

2011-09-23T15:21:46Z

Kornerr:

CEED

2011-09-20T14:05:47Z

Kornerr: /* Overview */

CEED

2011-09-20T14:05:16Z

Kornerr:

Use your custom widget in place of CEGUI standard one

2011-03-04T15:57:34Z

Kornerr:

{{VersionBadge|0.7}}

== Introduction ==

This article describes how to inherit CEGUI widget, enhance it the way you like, and then make sure it is used in place of CEGUI standard one when met in a layout file.

We will enhance CEGUI::MultiColumnList class. It's very powerful, but it's nice to have an easier interface for row addition.

== CustomMCL ==

This is our enhanced version of CEGUI::MultiColumnList.

Header:
<source lang = "cpp">
class CustomMCL : public CEGUI::MultiColumnList {
public:
CustomMCL(const CEGUI::String &type, const CEGUI::String &name);

void clear();
void createItem(const CEGUI::String &text);
void createRow();

// Unique widget name throughout CEGUI.
static CEGUI::String WidgetTypeName;

private:
int mRowID;
int mColID;
};
</source>
Source:
<source lang = "cpp">
CEGUI::String CustomMCL::WidgetTypeName = "CustomMCL";

CustomMCL::CustomMCL(const CEGUI::String &type, const CEGUI::String &name) :
CEGUI::MultiColumnList(type, name),
mRowID(-1) { }

void CustomMCL::clear() {
resetList();
mRowID = -1;
}

void CustomMCL::createItem(const CEGUI::String &text) {
CEGUI::ListboxTextItem *item = new CEGUI::ListboxTextItem(text);
setItem(item, mColID++, mRowID);
}

void CustomMCL::createRow() {
mRowID++;
mColID = 0;
addRow(mRowID);
}
</source>
Custom widget must contain the following public static variable:
<source lang = "cpp">
static CEGUI::String WidgetTypeName;
</source>
with the name unique among all CEGUI widgets. It's a name our custom widget will be registered under. We named it 'CustomMCL'.

Register the widget:
<source lang = "cpp">
CEGUI::WindowFactoryManager::getSingleton().addFactory<CEGUI::TplWindowFactory<CustomMCL> >();
</source>

Make sure our class is used in place of CEGUI one when met in a layout:
<source lang = "cpp">
CEGUI::WindowFactoryManager::getSingleton().addWindowTypeAlias("CEGUI/MultiColumnList", "CustomMCL");
</source>

== Example ==

Download [http://sourceforge.net/projects/osrpgcreation/files/Other/cegui_custom_widget.zip/download| example source code] (requires OGRE and OIS additionally)

Screenshot:
[[File:Cegui_custom_widget.png|center]]

[[Category:HowTo]]

Use your custom widget in place of CEGUI standard one

2011-03-03T18:48:58Z

Kornerr:

{{VersionBadge|0.7}}

== Introduction ==

This article describes how to inherit CEGUI widget, enhance it the way you like, and then make sure it is used in place of CEGUI standard one when met in a layout file.

We will enhance CEGUI::MultiColumnList class. It's very powerful, but it's nice to have an easier interface for row addition.

== CustomMCL ==

This is our enhanced version of CEGUI::MultiColumnList.

Header:
<source lang = "cpp">
class CustomMCL : public CEGUI::MultiColumnList {
public:
CustomMCL(const CEGUI::String &type, const CEGUI::String &name);

void clear();
void createItem(const CEGUI::String &text);
void createRow();

// Unique widget name throughout CEGUI.
static CEGUI::String WidgetTypeName;

private:
int mRowID;
int mColID;
};
</source>
Source:
<source lang = "cpp">
CEGUI::String CustomMCL::WidgetTypeName = "CustomMCL";

CustomMCL::CustomMCL(const CEGUI::String &type, const CEGUI::String &name) :
CEGUI::MultiColumnList(type, name),
mRowID(-1) { }

void CustomMCL::clear() {
resetList();
mRowID = -1;
}

void CustomMCL::createItem(const CEGUI::String &text) {
CEGUI::ListboxTextItem *item = new CEGUI::ListboxTextItem(text);
setItem(item, mColID++, mRowID);
}

void CustomMCL::createRow() {
mRowID++;
mColID = 0;
addRow(mRowID);
}
</source>
Custom widget must contain the following public static variable:
<source lang = "cpp">
static CEGUI::String WidgetTypeName;
</source>
with the name unique among all CEGUI widgets. It's a name our custom widget will be registered under. We named it 'CustomMCL'.

Register the widget:
<source lang = "cpp">
CEGUI::WindowFactoryManager::getSingleton().addFactory<CEGUI::TplWindowFactory<CustomMCL> >();
</source>

Make sure our class is used in place of CEGUI one when met in a layout:
<source lang = "cpp">
CEGUI::WindowFactoryManager::getSingleton().addWindowTypeAlias("CEGUI/MultiColumnList", "CustomMCL");
</source>

Example source code (requires OGRE and OIS additionally):
[TODO: put link to opengamestudio SF / Other / file]

Screenshot:
[[Image:Cegui_custom_widget.png|center]]

[[Category:HowTo]]

Use your custom widget in place of CEGUI standard one

2011-03-03T18:46:01Z

Kornerr: Created page with "{{VersionBadge|0.7}} == Introduction == This article describes how to inherit CEGUI widget, enhance it the way you like, and then make sure it is used in place of CEGUI standar..."

{{VersionBadge|0.7}}

== Introduction ==

This article describes how to inherit CEGUI widget, enhance it the way you like, and then make sure it is used in place of CEGUI standard one when met in a layout file.

We will enhance CEGUI::MultiColumnList class. It's very powerful, but it's nice to have an easier interface for row addition.

== CustomMCL ==

This is our enhanced version of CEGUI::MultiColumnList.

Header:
<source lang = "cpp">
class CustomMCL : public CEGUI::MultiColumnList {
public:
CustomMCL(const CEGUI::String &type, const CEGUI::String &name);

void clear();
void createItem(const CEGUI::String &text);
void createRow();

// Unique widget name throughout CEGUI.
static CEGUI::String WidgetTypeName;

private:
int mRowID;
int mColID;
};
</source>
Source:
<source lang = "cpp">
CEGUI::String CustomMCL::WidgetTypeName = "CustomMCL";

CustomMCL::CustomMCL(const CEGUI::String &type, const CEGUI::String &name) :
CEGUI::MultiColumnList(type, name),
mRowID(-1) { }

void CustomMCL::clear() {
resetList();
mRowID = -1;
}

void CustomMCL::createItem(const CEGUI::String &text) {
CEGUI::ListboxTextItem *item = new CEGUI::ListboxTextItem(text);
setItem(item, mColID++, mRowID);
}

void CustomMCL::createRow() {
mRowID++;
mColID = 0;
addRow(mRowID);
}
</source>
Custom widget must contain the following public static variable:
<source lang = "cpp">
static CEGUI::String WidgetTypeName;
</source>
with the name unique among all CEGUI widgets. It's a name our custom widget will be registered under. We named it 'CustomMCL'.

Register the widget:
<source lang = "cpp">
CEGUI::WindowFactoryManager::getSingleton().addFactory<CEGUI::TplWindowFactory<CustomMCL> >();
</source>

Make sure our class is used in place of CEGUI one when met in a layout:
<source lang = "cpp">
CEGUI::WindowFactoryManager::getSingleton().addWindowTypeAlias("CEGUI/MultiColumnList", "CustomMCL");
</source>

Example source code (requires OGRE and OIS additionally):
[TODO: put link to opengamestudio SF / Other / file]

Screenshot:
[[Image:Cegui_custom_widget.png|center]]

File:Cegui custom widget.png

2011-03-03T18:38:52Z

Kornerr: