Kamaelia docs : Kamaelia.UI.OpenGL.Label

OpenGL Label Widget

A Label widget for the OpenGL display service.

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

Example Usage

4 Labels with various sizes, colours, captions and positions:

    Label1 = Label(caption="That", size=(2,2,1), sidecolour=(0,200,0), position=(-3,0,-10)),
    Label2 = Label(caption="Boy", bgcolour=(200,100,0), position=(3,0,-10)),
    Label3 = Label(caption="Needs", margin=15, position=(-1,0,-10), rotation=(30,0,10)),
    Label4 = Label(caption="Therapy!", fontsize=20, size=(0.3,0.3,1), position=(1,0,-10)),
    ECHO = ConsoleEchoer(),
    linkages = {
        ("Label1", "outbox") : ("ECHO", "inbox"),
        ("Label2", "outbox") : ("ECHO", "inbox"),
        ("Label3", "outbox") : ("ECHO", "inbox"),
        ("Label4", "outbox") : ("ECHO", "inbox"),

How does it work?

This component is a subclass of OpenGLComponent. It overrides __init__(), setup(), draw(), handleEvents() and frame().

In setup() only buildCaption() gets called where the set caption is rendered on a pygame surface. This surface is then set as OpenGL texture.

In draw() a flat cuboid is drawn (if size is not specified) with the caption texture on both the front and the back surface.


class Label(OpenGLComponent)

Label(...) -> A new Label component.

A Label widget for the OpenGL display service.

Keyword arguments:

  • caption -- Label caption (default="Label")
  • bgcolour -- Colour of surfaces behind caption (default=(200,200,200))
  • fgcolour -- Colour of the caption text (default=(0,0,0)
  • sidecolour -- Colour of side planes (default=(200,200,244))
  • margin -- Margin size in pixels (default=8)
  • fontsize -- Font size for caption text (default=50)
  • pixelscaling -- Factor to convert pixels to units in 3d, ignored if size is specified (default=100)
  • thickness -- Thickness of Label widget, ignored if size is specified (default=0.3)

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


Pre-render the text to go on the label.


Draw label cuboid.


Build caption.


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)