August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year, primarily targeted around Python 3 and ecosystem compatibility. PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)

Kamaelia.UI.OpenGL.TexPlane

Textured Plane

A plane showing a texture loaded from an image file.

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

Example Usage

A plane showing an image loaded from the file "nemo.jpeg":

PLANE = TexPlane(position=(0, 0,-6), texture="nemo.jpeg").activate()

Axon.Scheduler.scheduler.run.runThreads()

How does it work?

This component is a subclass of OpenGLComponent (for OpenGLComponent functionality see its documentation). It overrides __init__(), setup(), draw().

In setup() the method loadTexture() get called which loads the texure from the image file specified. If the image in the file has dimensions which are not equal a power of two, the texture dimensions get enlarged (this is needed because of OpenGL texturing limitations).

In draw() a simple plane is drawn whith the loaded texture on it.


Kamaelia.UI.OpenGL.TexPlane.TexPlane

class TexPlane(OpenGLComponent)

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

A plane showing a texture loaded from an image file.

Keyword arguments:

  • tex -- image file name
  • pixelscaling -- factor for translation from pixels to units in 3D space (default=100.0)

Inboxes

Outboxes

Methods defined here

Warning!

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

draw(self)

Draws textured plane.

loadTexture(self)

Loads texture from specified image file.

setup(self)

Load texture.

Feedback

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