CEGUI Documentation? (pyogre.cegui)

CEGUI Documentation? (pyogre.cegui)

I'm trying to figure out how to use CEGUI. I'm looking at some samples I got from the repository but I can't find any documentation for the classes and/or functions used.

CEGUI Class docs
http://www.cegui.org.uk/api_reference/classes.html

Ogre class docs
http://www.ogre3d.org/docs/api/html/classes.html

OgreCEGUIRenderer is in neither of these reference docs. Where can I find documentation for this class?

Thank you for your time,
arrummzen

While it's not in the api docs, it is a subclass of CEGUI::Renderer, which is described here: http://www.cegui.org.uk/api_reference/c ... derer.html

Besides setting the renderer up, you should need to mess with the renderer very much. More important is CEGUI::System from which you can access just about anything. Docs on the system can be found here: http://www.cegui.org.uk/api_reference/c ... ystem.html

And of course if you use Python-Ogre the wrapped functions are documented as part of the Python-Ogre CEGUI module (using Pydoc )

Cheers
Andy

hmmm...

The constructor isn't documented? How am I supposed to know what the arguments to the constructor mean?

Will python-ogre be backwards compatible with PyOgre? I chose to use PyOgre because it appeared to be a more mature product. If python-ogre surpasses PyOgre, I'd like to be able to switch easily.

Thank you for your time,
Arrummzen

Efforts have been made to make sure the same set/get methods to property conversions are done. Currently the only incompatibilities between the two are automatic conversion of tuple to Ogre.Vector3 and Ogre.Colour, which Python-Ogre doesn't currently have, but will and the different import statements. The only downside right now is a slightly lack of complete Linux support but the should fixed shortly.

You should not use the term "backwards compatible" because Python-Ogre is a new direction for wrapping Ogre. It wraps more than PyOgre and it does it more thoroughly (It has OgreNewt and soon OgreODE as well) with Py++ and Boost.Python.

Oh, and the automatic pydoc generation is pretty cool, but we need some STL conversions on those arguments!

If it is hard to get to work on GNU/Linux odds are it will be harder to get to work on my system. I'll wait until support for Linux improves.

In the meanwhile, can I somehow read the python-ogre pydocs online? I'm having a hard time figuring the constructor for cegui.OgreCEGUIRenderer =/

Thank you for your time,
Arrummzen

Same as OgreCEGUIRenderer.h excluding parameter max_quads which is obsolete and set to 0.


window - Ogre::RenderWindow object.

RenderQueueGroupID / id
/// Use this queue for objects which must be rendered first e.g. backgrounds
RENDER_QUEUE_BACKGROUND = 0,
/// First queue (after backgrounds), used for skyboxes if rendered first
RENDER_QUEUE_SKIES_EARLY = 5,
RENDER_QUEUE_1 = 10,
RENDER_QUEUE_2 = 20,
RENDER_QUEUE_WORLD_GEOMETRY_1 = 25,
RENDER_QUEUE_3 = 30,
RENDER_QUEUE_4 = 40,
/// The default render queue
RENDER_QUEUE_MAIN = 50,
RENDER_QUEUE_6 = 60,
RENDER_QUEUE_7 = 70,
RENDER_QUEUE_WORLD_GEOMETRY_2 = 75,
RENDER_QUEUE_8 = 80,
RENDER_QUEUE_9 = 90,
/// Penultimate queue(before overlays), used for skyboxes if rendered last
RENDER_QUEUE_SKIES_LATE = 95,
/// Use this queue for objects which must be rendered last e.g. overlays
RENDER_QUEUE_OVERLAY = 100

default (Ogre::RENDER_QUEUE_OVERLAY)

post_queue
set to true to have GUI rendered after render queue queue_id, or false to have the GUI rendered before render queue queue_id.
( default - false )

sceneManager - sceneManager


C++ Constructor:

OgreCEGUIRenderer(Ogre::RenderWindow *window);

OgreCEGUIRenderer(Ogre::RenderWindow *window, int id, bool postQueue);

OgreCEGUIRenderer(Ogre::RenderWindow *window, Ogre::RenderQueueGroupID id, bool postQueue, Ogre::SceneManager *sceneManager);


Seems that the docstrings in cegui are missing, in cegui.i after:

using namespace CEGUI;
PyObject *handleException(CEGUI::Exception &e);
%}

add:

%feature("autodoc", "1");


In the meanwhile, can I somehow read the python-ogre pydocs online? I'm having a hard time figuring the constructor for cegui.OgreCEGUIRenderer =/

You can download an offline version of the Python-Ogre library docs from here http://python-ogre.python-hosting.com/wiki/Documentation

I'm not sure they will help though with your "pyogre" issues..