Kamaelia.UI.Pygame.Image.Image

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

class Image(Axon.Component.component)

Image([image][,position][,bgcolour][,size][,displayExtra][,maxpect]) -> new Image component

Pygame image display component. Image, and other properties can be changed at runtime.

Keyword arguments:

image -- Filename of image (default=None)
position -- (x,y) pixels position of top left corner (default=(0,0))
bgcolour -- (r,g,b) background colour (behind the image if size>image size)
size -- (width,height) pixels size of the area to render the iamge in (default=image size or (240,192) if no image specified)
displayExtra -- dictionary of any additional args to pass in request to Pygame Display service
maxpect -- (xscale,yscale) scaling to apply to image (default=no scaling)

Inboxes

control : Shutdown messages: shutdownMicroprocess or producerFinished
bgcolour : Set the background colour
callback : Receive callbacks from Pygame Display
inbox : Filename of (new) image
events : Place where we recieve events from the outside world
alphacontrol : Alpha (transparency) of the image (value 0..255)

Outboxes

outbox : NOT USED
signal : Shutdown signalling: shutdownMicroprocess or producerFinished
display_signal : Outbox used for sending signals of various kinds to the display service

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[, image][, position][, bgcolour][, size][, displayExtra][, maxpect][, expect_file_strings])

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

blitToSurface(self)

Blits the background colour and image file to the surface

fetchImage(self, newImage)

Load image from specified filename.

self.size is set to image dimensions if self.size is None.

Image is scaled by self.maxpect if self.maxpect evaluates to True.

imageFromString(self, newImage)

main(self)

Main loop.

waitBox(self, boxname)

Generator. yield's 1 until data is ready on the named inbox.

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)