klampt.vis.glcommon module

Defines GLWidgetPlugin, GLMultiViewportProgram, and CachedGLObject, which are used by the core visualization module. They may be useful for writing your own GLPluginInterface classes, too.

class klampt.vis.glcommon.GLWidgetPlugin

Bases: GLPluginInterface

A GL plugin that sends user events to one or more Klamp’t widgets. To use, add this to a GLPluginProgram and call addWidget to add widgets

addWidget(widget)

add_widget(widget)

widgetchangefunc(event)

Called whenever a widget is clicked or dragged. event can be ‘mousedown’, ‘mousedrag’, ‘mouseup’. Subclasses can use this to respond to widget click events

widgethoverfunc()

Called whenever a widget changes appearance due to hover. Subclasses can use this to respond to widget click events

display()

keyboardfunc(c, x, y)

keyboardupfunc(c, x, y)

mousefunc(button, state, x, y)

motionfunc(x, y, dx, dy)

idle()

class klampt.vis.glcommon.GLMultiViewportProgram

Bases: GLProgram

A GLProgram that splits the window into several sub-views. Each view is a GLProgram or GLPluginInterface.

initialize()

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

addView(view)

removeView(view)

clearViews()

add_view(view)

remove_view(view)

clear_views()

update_active(x, y)

fit()

reshapefunc(w, h)

Called on window resize. 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

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.

mousefunc(button, state, x, y)

Called when the mouse is clicked. May be overridden.

motionfunc(x, y, dx, dy)

Called when the mouse moves on screen. 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.

idlefunc()

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

refresh()

Spoofs the window’s refresh function

reshape(w, h)

Spoofs the window’s reshape function

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

Draws text of the given size and color at the given point. Usually called during display_screen.

click_ray(x, y)

get_view()

set_view(vp)

class klampt.vis.glcommon.CachedGLObject

Bases: object

An object whose drawing is accelerated by means of a display list. The draw function may draw the object in the local frame, and the object may be transformed without having to recompile the display list.

destroy()

Must be called to free up resources used by this object

markChanged()

mark_changed()

Marked by an outside source to indicate the object has changed and should be redrawn.

draw(renderFunction, transform=None, args=None, parameters=None)

Given the function that actually makes OpenGL calls, this will draw the object.

If parameters is given, the object’s local appearance is assumed to be defined deterministically from these parameters. The display list will be redrawn if the parameters change.