Kamaelia docs : Kamaelia.UI.OpenGL.Movement.PathMover

Kamaelia.UI.OpenGL.Movement.PathMover

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


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

__init__(self, path[, repeat])

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, 19 Oct 2008 at 14:29:09 UTC/GMT

This is a page from the Kamaelia website. You can find the original here: