April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.

Kamaelia.UI.OpenGL.Movement.WheelMover

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

class WheelMover(Axon.AdaptiveCommsComponent.AdaptiveCommsComponent)

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

A component to arrange several OpenGlComponents in the style of a big wheel rotating around the X axis. Can be used to switch between components.

Components can be added and removed during operation using the "notify" inbox. Messages sent to it are expected to be a dictionary of the following form:

{
    "APPEND_CONTROL" :True,
    "objectid": id(object),
    "control": (object,"position")
}

for adding components and:

{
    "REMOVE_CONTROL" :True,
    "objectid": id(object),
}

for removing components.

If components are added when the wheel is already full (number of slots exhausted) they are simply ignored.

The whole wheel can be controlles by sending messages to the "switch" inbox. The commands can be either "NEXT" or "PREVIOUS".

Keyword arguments:

steps -- number of steps the wheel is subdivided in (default=400)
center -- center of the wheel (default=(0,0,-13))
radius -- radius of the wheel (default=5)
slots -- number of components which can be handled (default=20)

Inboxes

control : ignored
switch : For reception of switching commands
inbox : not used
notify : For appending and removing components

Outboxes

outbox : Outbox for sending position updates

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[, steps][, center][, radius][, slots])

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

main(self)

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