Kamaelia docs : Kamaelia.UI.OpenGL.ProgressBar

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:

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

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.


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)

Methods defined here


You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

__init__(self, **argd)

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


Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)