Kamaelia.UI.Pygame.BasicSprite.BasicSprite

class BasicSprite(pygame.sprite.Sprite,Axon.Component.component)

BasicSprite(image[,position]) -> new BasicSprite component.

A sprite for a pygame application. Can be changed, moved, scaled and rotated on the fly.

Does not use the standard component 'main' loop - must be used in conjunction with SpriteSheduler.

Keyword arguments: - image -- pygame surface containing the image - position -- (x,y) pixels position of the top left corner (default=(10,10))

Inboxes

control : NOT USED
scaler : Change size (1.0=original)
inbox : NOT USED
rotator : Rotate by 'n' degrees counterclockwise
translation : Change position to (x,y) in pixels
imaging : Change the image

Outboxes

outbox : NOT USED
signal : Diagnostic messages

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)

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

main(self)

Main loop

pause(self)

Set paused flag, and signal "pause"

shutdown(self)

Send shutdown message

sprite_logic(self)

Effectively the main loop. Listens for messages on inboxes and adjusts the sprite accordingly, unless 'paused'.

togglePause(self)

Toggle between paused and unpaused states

unpause(self)

Unset paused flag, and signal "unpause"

Feedback

Got a problem with the documentation? Something unclear, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

Please leave the feedback here, in reply to the documentation thread in the Kamaelia blog.

(C) 2006 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved, 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.