klampt.vis.glinterface module

Defines the GLPluginInterface class, which is a unified base class for plugins to the klampt.vis module.

class klampt.vis.glinterface.GLPluginInterface

Bases: object

Users can add their own hooks into the visualizer by overloading this class’s methods. Each method should return True if the user event was processed. A return value of True stops cascading events to a parent interface.

window

the window to which this plugin is attached. May be None if not attached to an OpenGL window.

Type

QtGLWindow or GLUTWindow

view

the viewport that is currently being used for this plugin.

Type

GLViewport

actions

internally used.

Type

list

add_action(callback, short_name, 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.

click_ray(x, y)

Returns the world-space ray associated with the camera click at pixel coordinates x,y.

closefunc()

display()

display_screen()

displayfunc()

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

Draws text of the given size and color at the point (x,y) or (x,y,z). The former method is usually called during display_screen.

eventfunc(type, args='')

Generic hook for other events, e.g., button presses, from the GUI

idle()

idlesleep(seconds)

Asks to sleep the idle function for seconds seconds.

initialize()

Called by backend after the GL context is created but before the event loop starts.

keyboardfunc(c, x, y)

keyboardupfunc(c, x, y)

modifiers()

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

motionfunc(x, y, dx, dy)

mousefunc(button, state, x, y)

refresh()

Asks for a redraw

reshape(w, h)

Asks to resize the GL window

reshapefunc(w, h)

viewport()

Returns the Viewport instance associated with the current GL view.