Package pygsear :: Module Drawable :: Class MultiImage
[show private | hide private]
[frames | no frames]

Class MultiImage

object --+        
         |        
    Sprite --+    
             |    
      Drawable --+
                 |
                MultiImage

Known Subclasses:
MultiImageCursor, RotatedImage

Multiple images from multiple files.
Method Summary
  __init__(self, w, filenames, dirname, defaultImage, colorkey, convert)
Load multiple images from multiple files
  addImage(self, filename, image, colorkey, convert)
add image to list of available images
  flip(self, imageName)
switch image by name
  removeImage(self, key)
remove image by name
  stretch(self, dx, dy, size, keepAspectRatio)
Change the size of sprite's image, and rect.
    Inherited from Drawable
bool can_see(self, target, blocking_rects_list)
Performs a los (line of sight) check from the center of the source to the center of the target.
  center(self, x, y, dx, dy)
Align the Drawable in its layer
  clear(self, surface)
Erase sprite to background
bool collide(self, other)
return True if this sprite and other sprite overlap.
Drawable or False collidelist(self, lothers)
return True if this sprite and any in list of others collide.
List collidelistall(self, lothers)
return True if this sprite and any in list of others collide.
  direction(self, point)
return the direction from the sprite to a point
  distance(self, point)
return the distance from the sprite to a point
  draw(self, surface)
Blit image to layer
  get_position(self)
return a copy of the sprite's position
  get_size(self)
return size of sprite's rect.
  move(self)
set position to next position on path
  nudge(self, dx, dy)
Move sprite.
  onscreen(self, slack, **kw)
return True if image is on the screen or layer.
  pause(self)
stop moving along Path
  runPath(self, frames)
call move() continuously
  set_crect(self, crect)
set the collision pygame.Rect used for collision checking.
  set_path(self, path)
set which path to follow
  set_position(self, location, *args)
Move sprite to location.
  set_positionRandom(self, slack)
Move sprite to a random location on screen
  set_size(self, size)
Set size of sprite's rect.
  solid(self, other, move_both)
move sprite so that it does not overlap with other sprite
  uclear(self, surface)
clear sprite and update display
  udraw(self, surface)
Draw image and update display.
  unpause(self)
start moving along Path
    Inherited from Sprite
  __repr__(self)
  add(self, *groups)
add(group or list of of groups, ...) add a sprite to container
  add_internal(self, group)
  alive(self)
alive() -> bool check to see if the sprite is in any groups
  groups(self)
groups() -> list of groups list used sprite containers
  kill(self)
kill() remove this sprite from all groups
  remove(self, *groups)
remove(group or list of groups, ...) remove a sprite from container
  remove_internal(self, group)
  update(self, *args)
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T

Class Variable Summary
NoneType filenames = None                                                                  

Method Details

__init__(self, w=None, filenames=None, dirname=None, defaultImage=None, colorkey=(0, 51, 0, 0), convert=1)
(Constructor)

Load multiple images from multiple files

Images get stored in a dict for retrieval by name.
Parameters:
w - Screen.Layer to draw in.
filenames - List of image file names to load.
dirname - Name of directory from which to load all images.
defaultImage - Name of the default image.
colorkey - RGB tuple to use for transparency.
convert - If True, call convert() for all images.
Overrides:
pygsear.Drawable.Drawable.__init__

addImage(self, filename='default', image=None, colorkey=(0, 51, 0, 0), convert=1)

add image to list of available images
Parameters:
filename - string file name from which to load image If image is not None, file is used as the name (key) to access the image.
image - image (Surface) to add

flip(self, imageName='default')

switch image by name
Parameters:
imageName - string with name of image (without file type suffix)

removeImage(self, key)

remove image by name

stretch(self, dx=None, dy=None, size=None, keepAspectRatio=1)

Change the size of sprite's image, and rect.
Parameters:
dx - Number of pixels to stretch in the x direction (can be neg)
dy - Number of pixels to stretch in the y direction (can be neg)
size - Tuple with new overall size (width, height)
keepAspectRatio - If True, the new image will be padded with transparent borders.
Overrides:
pygsear.Drawable.Drawable.stretch

Class Variable Details

filenames

Type:
NoneType
Value:
None                                                                  

Generated by Epydoc 2.0 on Sat Dec 9 14:11:19 2006 http://epydoc.sf.net