Kamaelia.UI.OpenGL.OpenGLDisplay.OpenGLDisplay

For examples and more explanations, see the module level docs.

---

class OpenGLDisplay(Axon.AdaptiveCommsComponent.AdaptiveCommsComponent)

OpenGLDisplay(...) -> new OpenGLDisplay component

Use OpenGLDisplay.getDisplayService(...) in preference as it returns an existing instance, or automatically creates a new one.

Or create your own and register it with setDisplayService(...)

Keyword arguments (all optional):

• title -- caption of window (default=http://kamaelia.sourceforge.net)

• width -- pixels width (default=800)

• height -- pixels height (default=600)

• background_colour -- (r,g,b) background colour (default=(255,255,255))

• fullscreen -- set to True to start up fullscreen, not windowed (default=False)

• show_fps -- show frames per second in window title (default=True)

• limit_fps -- maximum frame rate (default=60)

  Projection parameters

• near -- distance to near plane (default=1.0)

• far -- distance to far plane (default=100.0)

• perspective -- perspective angle (default=45.0)

  Viewer position and orientation

• viewerposition -- position of viewer (default=(0,0,0))

• lookat -- look at point (default= (0,0,-self.farPlaneDist))

• up -- up vector (default(0,1,0))

  Fog

• fog -- tuple of fog distances (start, end). if not set, fog is disabled (default)

• fog_colour -- (r,g,b) fog colour (default=(255,255,255) )

• fog_density -- fog density (default=0.35)

  Event processing

• hitall -- boolean, if false, only the nearest object under the cursor gets activated (default=False)

Inboxes

• control : NOT USED
• events : For reception of pygame events
• inbox : Default inbox, not currently used
• notify : For reception of requests for surfaces, overlays and events

Outboxes

• outbox : NOT USED
• signal : NOT USED

Methods defined here

__init__(self, **argd)

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

calcPow2Size(self, size)

Calculates the power of 2 dimensions for a given size.

doPicking(self, pos)

Uses OpenGL picking to determine objects that have been hit by mouse pointer. see e.g. OpenGL Redbook

drawOpenGLComponents(self)

Draws all registered OpenGL components with their set transformation matrix.

drawPygameSurfaces(self)

Draws all surfaces of registered pygame components on top of everything else.

genIdentifier(self)

Returns a unique number.

handleEvents(self)

Handles pygame input events.

handleOGLComponentEvents(self, events)

Prepare and send input events for OpenGL components.

handlePygameComponentEvents(self, events)

Prepare and send input events for pygame components.

handleRequest_DISPLAYREQUEST(self, message)

handleRequest_EVENTSPYREQUEST(self, message)

handleRequest_OGL_DISPLAYREQUEST(self, message)

handleRequest_WRAPPERREQUEST(self, message)

handleRequests(self)

Handles service requests.

main(self)

Main loop.

setProjection(self)

Sets projection matrix.

surfacePosition(self, surface)

Returns a suggested position for a surface. No guarantees its any good!

updateDisplay(self)

Draws all components, updates screen, clears the backbuffer and depthbuffer .

updatePygameTexture(self, surface, pow2surface, texname)

Converts the surface of a pygame component to an OpenGL 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