Kamaelia.UI.OpenGL.ProgressBar

• component ProgressBar

• Progress Bar
  • Example Usage
  • How does it work?

Progress Bar

A progress bar widget for the OpenGL display service.

This component is a subclass of OpenGLComponent and therefore uses the OpenGL display service.

Example Usage

A progress bar with changing value:

Graphline(
    BOUNCE = bouncingFloat(0.5),
    PROGRESS = ProgressBar(size = (3, 0.5, 0.2), position=(0,0,-10), progress=0.5),
    linkages = {
        ("BOUNCE", "outbox"):("PROGRESS", "progress"),
    }
).run()

How does it work?

ProgressBar is a subclass of OpenGLComponent (for OpenGLComponent functionality see its documentation). It overrides __init__(), draw(), handleEvents() and frame().

This component basically draws a cuboid shaped cage and inside of it a transparent bar indicating a percentage.

The percentage values are received at the "progress" inbox. The values must be in the range [0,1]. If the value is 0.0, the bar is not drawn at all, if 1.0 the bar has its maximum length. Received values which lie outside of this range are clamped to it.

Because the progress bar is transparent, the widget has to be drawn in a special order. First, the cage is drawn normally. Then the depth buffer is made read only and the transparent bar is drawn.

---

Kamaelia.UI.OpenGL.ProgressBar.ProgressBar

class ProgressBar(OpenGLComponent)

ProgressBar(...) -> new ProgressBar component.

Create a progress bar widget using the OpenGLDisplay service. Shows a tranparent bar indicating a percentage.

Keyword arguments:

• cagecolour -- Cage colour (default=(0,0,0))
• barcolour -- Bar colour (default=(200,200,244))
• progress -- Initial progress value (default=0.0)

Inboxes

Outboxes

Methods defined here

__init__(self, **argd)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

draw(self)

frame(self)

handleProgress(self)