Kamaelia docs : Kamaelia.UI.OpenGL.Movement

A collection of movement components and classes

Contained components:

  • PathMover
  • WheelMover
  • SimpleRotator
  • SimpleBuzzer

Contained classes:

  • LinearPath

For a description of these classes have a look at their class documentation.

Example Usage

The following example show the usage of most of the components in this file (for an example how to use the WheelMover, see the TorrentOpenGLGUI example):

points = [(3,3,-20),
          (4,0,-20),
          (3,-3,-20),
          (0,-4,-20),
          (-3,-3,-20),
          (-4,0,-20),
          (-3,3,-20),
          (0,4,-20),
          (3,3,-20),
         ]
path = LinearPath(points, 1000)

cube1 = SimpleCube(size=(1,1,1)).activate()
pathmover = PathMover(path).activate()
pathmover.link((pathmover,"outbox"), (cube1,"position"))

cube2 = SimpleCube(size=(1,1,1)).activate()
simplemover = SimpleMover().activate()
simplemover.link((simplemover,"outbox"), (cube2,"position"))

cube3 = SimpleCube(size=(1,1,1), position=(-1,0,-15)).activate()
rotator = SimpleRotator().activate()
rotator.link((rotator,"outbox"), (cube3,"rel_rotation"))

cube4 = SimpleCube(size=(1,1,1), position=(1,0,-15)).activate()
buzzer = SimpleBuzzer().activate()
buzzer.link((buzzer,"outbox"), (cube4,"scaling"))

Axon.Scheduler.scheduler.run.runThreads()

Kamaelia.UI.OpenGL.Movement.PathMover

class PathMover(Axon.Component.component)

PathMover(...) -> A new PathMover object.

PathMover can be used to move a 3d object along a path.

It can be controlled by sending commands to its inbox. These commands can be one of "Play", "Stop", "Next", "Previous", "Rewind", "Forward" and "Backward".

If the pathmover reaches the beginning or the end of a path it generates a status message which is sent to the "status" outbox. This message can be "Finish" or "Start".

Keyword arguments:

  • path -- A path object (e.g. LinearPath) or a list of points
  • repeat -- Boolean indication if the Pathmover should repeat the path if it reaches an end (default=True)

Inboxes

  • control : ignored
  • inbox : Commands are received here

Outboxes

  • status : Used to send status messages
  • outbox : Outbox for sending Control3D commands

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, path[, repeat])

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

Kamaelia.UI.OpenGL.Movement.SimpleBuzzer

class SimpleBuzzer(Axon.Component.component)

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

A simple buzzer component mostly for testing. Changes the scaling of OpenGLComponents it connected to their "scaling" boxes.

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.

Kamaelia.UI.OpenGL.Movement.SimpleMover

class SimpleMover(Axon.Component.component)

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

A simple mover component mostly for testing. Moves OpenGLComponents between the specified borders if connected to their "position" boxes. The amount of movement every frame and the origin can also be specified.

Keyword arguments:

  • amount -- amount of movement every frame sent (default=(0.03,0.03,0.03))
  • borders -- borders of every dimension (default=(5,5,5))
  • origin -- origin of movement (default=(0,0,-20))

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[, amount][, borders][, origin])

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

Kamaelia.UI.OpenGL.Movement.SimpleRotator

class SimpleRotator(Axon.Component.component)

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

A simple rotator component mostly for testing. Rotates OpenGLComponents by the amount specified if connected to their "rel_rotation" boxes.

Keyword arguments:

  • amount -- amount of relative rotation sent (default=(0.1,0.1,0.1))

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[, amount])

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

Kamaelia.UI.OpenGL.Movement.WheelMover

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

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


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)