klampt.vis.glprogram module

Internal classes for building 3D GUI programs.

• GLProgram takes care of basic user input.

• GLNavigationProgram allows 3D navigation with the mouse.

• GLRealtimeProgram calls a subclass-defined idle() function roughly on a constant time step.

class klampt.vis.glprogram.GLProgramAction(hook, short_text, key, description=None)

Bases: object

class klampt.vis.glprogram.GLProgram(name='OpenGL Program')

Bases: object

A basic OpenGL visualization, run as part of some _GLBackend. For the most part there is a one-to-one correspondence and the backend just relays the input / drawing messages

Assumes that glinit.py has been imported to define _GLBackend.

name

title of the window (only has an effect before calling run())

Type:

str

window

the QtBackend or GLUTBackend instance

view

describes the OpenGL viewport. If this is provided to an empty _GLBackend window, the w,h gives a hint to the size of the window. It is then updated by the user and setting the viewport size has no effect on the window.

Type:

GLViewport

clearColor

the RGBA floating point values of the background color.

Type:

list of 4 floats

actions

the list of actions. Must be populated using add_action before init().

Type:

list of GLProgramAction

add_action(hook, short_text, key, description=None)

Defines a new generic GUI action. The action will be available in a menu in Qt or as keyboard commands in GLUT.

run()

Starts a new event loop with this object as the main program. Note: might not return, in the case of GLUT.

initialize()

Called after the GL context is initialized, but before main loop. May be overridden. Users should not call this directly!

refresh()

Call this to redraw the screen on the next event loop

modifiers()

Retrieves a list of currently pressed keyboard modifiers. Values can be any combination of ‘ctrl’, ‘shift’, ‘alt’.

reshape(w, h)

Asks to resize the GL window

reshapefunc(w, h)

Called on window resize. May be overridden.

print_help()

keyboardfunc(c, x, y)

Called on keypress down. May be overridden. c is either the ASCII/unicode character of the key pressed or a string describing the character (up,down,left,right, home,end,delete,enter,f1,…,f12)

keyboardupfunc(c, x, y)

Called on keyboard up (if your system allows it). May be overridden.

motionfunc(x, y, dx, dy)

Called when the mouse moves on screen. May be overridden.

mousefunc(button, state, x, y)

Called when the mouse is clicked. May be overridden.

mousewheelfunc(dhorizontal, dvertical, x, y)

Called when the wheel is scrolled. Most wheels have dhorizontal=0. x and y are the position of the mouse when the wheel is scrolled. May be overridden.

displayfunc()

All OpenGL calls go here. May be overridden, although you may wish to override display() and display_screen() instead.

idlefunc()

Called on idle. Default value stops all additional idle calls. Must be overridden if you want to do something in the idle loop.

idlesleep(duration=inf)

Sleeps the idle callback for t seconds. If t is not provided, the idle callback is slept forever

prepare_GL()

Prepare drawing in world coordinate frame

prepare_screen_GL()

Prepare drawing on screen

display()

Do drawing of objects in world

display_screen()

Do drawing of objects on screen

closefunc()

Called by the window when it is closed

get_screen(format='auto', want_depth=False)

Retrieves a screenshot

save_screen(fn, multithreaded=True)

Saves a screenshot

draw_text(point, text, size=12, color=None)

class klampt.vis.glprogram.GLNavigationProgram(name)

Bases: GLProgram

A more advanced form of GLProgram that allows you to navigate a camera around a 3D world. Click-drag rotates, Control-drag translates, Shift-drag zooms.

get_view()

Returns a GLViewport describing the viewport, which could be saved to file.

set_view(v)

Sets the viewport to a tuple previously returned by get_view(), e.g. a prior view that was saved to file.

prepare_GL()

Prepares for OpenGL rendering with the current modelview matrix and default lights.

set_lights_GL()

Sets the default OpenGL lights

motionfunc(x, y, dx, dy)

Called when the mouse moves on screen. May be overridden.

mousefunc(button, state, x, y)

Called when the mouse is clicked. May be overridden.

mousewheelfunc(dhorizontal, dvertical, x, y)

Called when the wheel is scrolled. Most wheels have dhorizontal=0. x and y are the position of the mouse when the wheel is scrolled. May be overridden.

class klampt.vis.glprogram.GLRealtimeProgram(name)

Bases: GLNavigationProgram

A GLNavigationProgram that refreshes the screen at a given frame rate.

ttotal

total elapsed time assuming a constant frame rate

Type:

float

fps

the frame rate in Hz

Type:

float

dt

1.0/fps

Type:

float

counter

a frame counter

Type:

int

lasttime

time.time() value on the last frame.

Type:

float

idlefunc()

Called on idle. Default value stops all additional idle calls. Must be overridden if you want to do something in the idle loop.

idle()

class klampt.vis.glprogram.GLPluginProgram(name='GLPluginProgram')

Bases: GLRealtimeProgram

This base class should be used with a GLPluginBase object to handle the GUI functionality (see glcommon.py). Call setPlugin() on this object to set the currently used plugin. pushPlugin()/popPlugin() can also be used to set a hierarchy of plugins.

setPlugin(plugin)

pushPlugin(plugin)

popPlugin()

set_plugin(plugin)

push_plugin(plugin)

pop_plugin()

set_view(v)

Sets the viewport to a tuple previously returned by get_view(), e.g. a prior view that was saved to file.

initialize()

Called after the GL context is initialized, but before main loop. May be overridden. Users should not call this directly!

idle()

reshapefunc(w, h)

Called on window resize. May be overridden.

keyboardfunc(c, x, y)

Called on keypress down. May be overridden. c is either the ASCII/unicode character of the key pressed or a string describing the character (up,down,left,right, home,end,delete,enter,f1,…,f12)

keyboardupfunc(c, x, y)

Called on keyboard up (if your system allows it). May be overridden.

motionfunc(x, y, dx, dy)

Called when the mouse moves on screen. May be overridden.

mousefunc(button, state, x, y)

Called when the mouse is clicked. May be overridden.

displayfunc()

All OpenGL calls go here. May be overridden, although you may wish to override display() and display_screen() instead.

display()

Do drawing of objects in world

display_screen()

Do drawing of objects on screen