Panda3D
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Static Public Member Functions
RocketRegion Class Reference

Represents a region in a window or buffer where the libRocket UI will be rendered to. More...

List of all members.

Public Member Functions

PyObject getContext ()
 Returns a pointer to the Rocket context associated with this region.
RocketInputHandler getInputHandler ()
 Returns the RocketInputHandler object previously passed to set_input_handler.
bool initDebugger ()
 Initializes the libRocket debugger.
bool isDebuggerVisible ()
 Returns true if the debugger is visible.
 setDebuggerVisible (bool visible)
 Sets whether the debugger should be visible.
 setInputHandler (RocketInputHandler handler)
 Sets the RocketInputHandler object from which to gather the keyboard and mouse inputs to pass to the libRocket context before rendering.

Static Public Member Functions

static TypeHandle getClassType ()
static RocketRegion make (string context_name, GraphicsOutput window)
 Creates a libRocket context with the given name (must be unique) for the given window.
static RocketRegion make (string context_name, GraphicsOutput window, VBase4 const dimensions)
 Creates a libRocket context with the given name (must be unique) for the given window.

Detailed Description

Represents a region in a window or buffer where the libRocket UI will be rendered to.


Member Function Documentation

static TypeHandle getClassType ( ) [static]
PyObject getContext ( )

Returns a pointer to the Rocket context associated with this region.

Will only be valid as long as this region still exists, so be sure to toss it when you toss the region itself. It's best to call this method just once and store the context in a Python variable, to avoid overhead.

Returns the RocketInputHandler object previously passed to set_input_handler.

bool initDebugger ( )

Initializes the libRocket debugger.

This will return false if the debugger failed to initialize, or if support for the debugger has not been built in (for example in an optimize=4 build).

Returns true if the debugger is visible.

static RocketRegion make ( string  context_name,
GraphicsOutput  window 
) [static]

Creates a libRocket context with the given name (must be unique) for the given window.

Returns a new DisplayRegion where the libRocket context will render to. This variant of make() creates a region that fills the entire window.

static RocketRegion make ( string  context_name,
GraphicsOutput  window,
VBase4 const  dimensions 
) [static]

Creates a libRocket context with the given name (must be unique) for the given window.

Returns a new DisplayRegion where the libRocket context will render to.

setDebuggerVisible ( bool  visible)

Sets whether the debugger should be visible.

Sets the RocketInputHandler object from which to gather the keyboard and mouse inputs to pass to the libRocket context before rendering.

You may use one input handler to provide inputs to any number of RocketRegion objects.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties