diff options
Diffstat (limited to 'TurtleArt/sprites.py')
| -rw-r--r-- | TurtleArt/sprites.py | 287 |
1 files changed, 161 insertions, 126 deletions
diff --git a/TurtleArt/sprites.py b/TurtleArt/sprites.py index 8bd3738..a67046f 100644 --- a/TurtleArt/sprites.py +++ b/TurtleArt/sprites.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- #Copyright (c) 2007-8, Playful Invention Company. -#Copyright (c) 2008-10 Walter Bender +#Copyright (c) 2008-11 Walter Bender #Permission is hereby granted, free of charge, to any person obtaining a copy #of this software and associated documentation files (the "Software"), to deal @@ -21,29 +21,23 @@ #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN #THE SOFTWARE. -""" +''' sprites.py is a simple sprites library for managing graphics objects, -'sprites', on a canvas. It manages multiple sprites with methods such -as move, hide, set_layer, etc. +'sprites', on a gtk.DrawingArea. It manages multiple sprites with +methods such as move, hide, set_layer, etc. There are two classes: -class Sprites maintains a collection of sprites. +class Sprites maintains a collection of sprites class Sprite manages individual sprites within the collection. Example usage: # Import the classes into your program. from sprites import Sprites Sprite - # In your expose callback event handler, call refresh - def _expose_cb(self, win, event): - self.sprite_list.refresh(event) - return True - - # Create a new sprite collection for a gtk Drawing Area. - my_drawing_area = gtk.DrawingArea() - self.sprite_list = Sprites(my_drawing_area) + # Create a new sprite collection associated with your widget + self.sprite_list = Sprites(widget) # Create a "pixbuf" (in this example, from SVG). my_pixbuf = svg_str_to_pixbuf("<svg>...some svg code...</svg>") @@ -52,7 +46,7 @@ Example usage: my_sprite = sprites.Sprite(self.sprite_list, x1, y1, my_pixbuf) # Move the sprite to a new position. - my_sprite.move_relative((dx, dy)) + my_sprite.move((x1+dx, y1+dy)) # Create another "pixbuf". your_pixbuf = svg_str_to_pixbuf("<svg>...some svg code...</svg>") @@ -68,6 +62,10 @@ Example usage: # Now put my_sprite on top of your_sprite. my_sprite.set_layer(300) + cr = self.window.cairo_create() + # In your activity's do_expose_event, put in a call to redraw_sprites + self.sprites.redraw_sprites(event.area, cairo_context) + # method for converting SVG to a gtk pixbuf def svg_str_to_pixbuf(svg_string): pl = gtk.gdk.PixbufLoader('svg') @@ -75,46 +73,46 @@ def svg_str_to_pixbuf(svg_string): pl.close() pixbuf = pl.get_pixbuf() return pixbuf -""" + +''' import pygtk pygtk.require('2.0') import gtk import pango +import pangocairo class Sprites: - """ A class for the list of sprites and everything they share in common """ - - def __init__(self, canvas, area=None, gc=None): - """ Initialize an empty array of sprites """ - self.canvas = canvas - if area == None: - self.area = self.canvas.window - self.gc = self.area.new_gc() - else: - self.area = area - self.gc = gc - self.cm = self.gc.get_colormap() + ''' A class for the list of sprites and everything they share in common ''' + + def __init__(self, widget): + ''' Initialize an empty array of sprites ''' + self.widget = widget self.list = [] + self.cr = None + + def set_cairo_context(self, cr): + ''' Cairo context may be set or reset after __init__ ''' + self.cr = cr def get_sprite(self, i): - """ Return a sprint from the array """ + ''' Return a sprint from the array ''' if i < 0 or i > len(self.list) - 1: return(None) else: return(self.list[i]) def length_of_list(self): - """ How many sprites are there? """ + ''' How many sprites are there? ''' return(len(self.list)) def append_to_list(self, spr): - """ Append a new sprite to the end of the list. """ + ''' Append a new sprite to the end of the list. ''' self.list.append(spr) def insert_in_list(self, spr, i): - """ Insert a sprite at position i. """ + ''' Insert a sprite at position i. ''' if i < 0: self.list.insert(0, spr) elif i > len(self.list) - 1: @@ -123,43 +121,46 @@ class Sprites: self.list.insert(i, spr) def remove_from_list(self, spr): - """ Remove a sprite from the list. """ + ''' Remove a sprite from the list. ''' if spr in self.list: self.list.remove(spr) - def find_sprite(self, pos, alpha=True): - """ Search based on (x, y) position. Return the 'top/first' one. """ + def find_sprite(self, pos): + ''' Search based on (x, y) position. Return the 'top/first' one. ''' list = self.list[:] list.reverse() for spr in list: if spr.hit(pos): - if not alpha or spr.get_pixel(pos)[3] == 255: - return spr + return spr return None - def refresh(self, event): - """ Handle expose event refresh """ - self.redraw_sprites(event.area) - - def redraw_sprites(self, area=None): - """ Redraw the sprites that intersect area. """ + def redraw_sprites(self, area=None, cr=None): + ''' Redraw the sprites that intersect area. ''' + # I think I need to do this to save Cairo some work + if cr is None: + cr = self.cr + else: + self.cr = cr + if cr is None: + print 'sprites.redraw_sprites: no Cairo context' + return for spr in self.list: if area == None: - spr.draw() + spr.draw(cr=cr) else: intersection = spr.rect.intersect(area) if intersection.width > 0 or intersection.height > 0: - spr.draw() + spr.draw(cr=cr) class Sprite: - """ A class for the individual sprites """ + ''' A class for the individual sprites ''' def __init__(self, sprites, x, y, image): - """ Initialize an individual sprite """ + ''' Initialize an individual sprite ''' self._sprites = sprites - self.rect = gtk.gdk.Rectangle(int(x), int(y), 0, 0) self.save_xy = (x, y) # remember initial (x, y) position + self.rect = gtk.gdk.Rectangle(int(x), int(y), 0, 0) self._scale = [12] self._rescale = [True] self._horiz_align = ["center"] @@ -172,16 +173,18 @@ class Sprite: self.layer = 100 self.labels = [] self.images = [] + self.surfaces = [] self._dx = [] # image offsets self._dy = [] + self.type = None self.set_image(image) - if self._sprites is not None: - self._sprites.append_to_list(self) + self._sprites.append_to_list(self) def set_image(self, image, i=0, dx=0, dy=0): - """ Add an image to the sprite. """ + ''' Add an image to the sprite. ''' while len(self.images) < i + 1: self.images.append(None) + self.surfaces.append(None) self._dx.append(0) self._dy.append(0) self.images[i] = image @@ -201,47 +204,42 @@ class Sprite: if h + dy > self.rect.height: self.rect.height = h + dy - def move(self, pos, visible=True): - """ Move to new (x, y) position """ - if visible: - self.inval() + def move(self, pos): + ''' Move to new (x, y) position ''' + self.inval() self.rect.x, self.rect.y = int(pos[0]), int(pos[1]) - if visible: - self.inval() + self.inval() - def move_relative(self, pos, visible=True): - """ Move to new (x+dx, y+dy) position """ - if visible: - self.inval() + def move_relative(self, pos): + ''' Move to new (x+dx, y+dy) position ''' + self.inval() self.rect.x += int(pos[0]) self.rect.y += int(pos[1]) - if visible: - self.inval() + self.inval() def get_xy(self): - """ Return current (x, y) position """ + ''' Return current (x, y) position ''' return (self.rect.x, self.rect.y) def get_dimensions(self): - """ Return current size """ + ''' Return current size ''' return (self.rect.width, self.rect.height) def get_layer(self): - """ Return current layer """ + ''' Return current layer ''' return self.layer def set_shape(self, image, i=0): - """ Set the current image associated with the sprite """ + ''' Set the current image associated with the sprite ''' self.inval() self.set_image(image, i) self.inval() - def set_layer(self, layer): - """ Set the layer for a sprite """ - if self._sprites is None: - return + def set_layer(self, layer=None): + ''' Set the layer for a sprite ''' self._sprites.remove_from_list(self) - self.layer = layer + if layer is not None: + self.layer = layer for i in range(self._sprites.length_of_list()): if layer < self._sprites.get_sprite(i).layer: self._sprites.insert_in_list(self, i) @@ -251,7 +249,7 @@ class Sprite: self.inval() def set_label(self, new_label, i=0): - """ Set the label drawn on the sprite """ + ''' Set the label drawn on the sprite ''' self._extend_labels_array(i) if type(new_label) is str or type(new_label) is unicode: # pango doesn't like nulls @@ -261,15 +259,15 @@ class Sprite: self.inval() def set_margins(self, l=0, t=0, r=0, b=0): - """ Set the margins for drawing the label """ + ''' Set the margins for drawing the label ''' self._margins = [l, t, r, b] def _extend_labels_array(self, i): - """ Append to the labels attribute list """ + ''' Append to the labels attribute list ''' if self._fd is None: self.set_font('Sans') if self._color is None: - self._color = self._sprites.cm.alloc_color('black') + self._color = (0., 0., 0.) while len(self.labels) < i + 1: self.labels.append(" ") self._scale.append(self._scale[0]) @@ -278,16 +276,27 @@ class Sprite: self._vert_align.append(self._vert_align[0]) def set_font(self, font): - """ Set the font for a label """ + ''' Set the font for a label ''' self._fd = pango.FontDescription(font) def set_label_color(self, rgb): - """ Set the font color for a label """ - self._color = self._sprites.cm.alloc_color(rgb) + ''' Set the font color for a label ''' + COLORTABLE = {'black': '#000000', 'white': '#FFFFFF', + 'red': '#FF0000', 'yellow': '#FFFF00', + 'green': '#00FF00', 'cyan': '#00FFFF', + 'blue': '#0000FF', 'purple': '#FF00FF', + 'gray': '#808080'} + if rgb.lower() in COLORTABLE: + rgb = COLORTABLE[rgb.lower()] + # Convert from '#RRGGBB' to floats + self._color = (int('0x' + rgb[1:3], 16) / 256., + int('0x' + rgb[3:5], 16) / 256., + int('0x' + rgb[5:7], 16) / 256.) + return def set_label_attributes(self, scale, rescale=True, horiz_align="center", vert_align="middle", i=0): - """ Set the various label attributes """ + ''' Set the various label attributes ''' self._extend_labels_array(i) self._scale[i] = scale self._rescale[i] = rescale @@ -295,37 +304,51 @@ class Sprite: self._vert_align[i] = vert_align def hide(self): - """ Hide a sprite """ - if self._sprites is None: - return + ''' Hide a sprite ''' self.inval() self._sprites.remove_from_list(self) - def inval(self): - """ Force a region redraw by gtk """ - if self._sprites is None: - return - self._sprites.area.invalidate_rect(self.rect, False) + def restore(self): + ''' Restore a hidden sprite ''' + self.set_layer() - def draw(self): - """ Draw the sprite (and label) """ - if self._sprites is None: + def inval(self): + ''' Invalidate a region for gtk ''' + # self._sprites.window.invalidate_rect(self.rect, False) + self._sprites.widget.queue_draw_area(self.rect.x, + self.rect.y, + self.rect.width, + self.rect.height) + + def draw(self, cr=None): + ''' Draw the sprite (and label) ''' + if cr is None: + print 'sprite.draw: no Cairo context.' return + # Fix me: Cache cairo surfaces for i, img in enumerate(self.images): - if isinstance(img, gtk.gdk.Pixbuf): - self._sprites.area.draw_pixbuf(self._sprites.gc, img, 0, 0, - self.rect.x + self._dx[i], - self.rect.y + self._dy[i]) - elif img is not None: - self._sprites.area.draw_drawable(self._sprites.gc, img, 0, 0, - self.rect.x + self._dx[i], - self.rect.y + self._dy[i], - -1, -1) + if self.surfaces[i] is not None: + cr.set_source_surface(self.surfaces[i], + self.rect.x + self._dx[i], + self.rect.y + self._dy[i]) + elif isinstance(img, gtk.gdk.Pixbuf): + cr.set_source_pixbuf(img, + self.rect.x + self._dx[i], + self.rect.y + self._dy[i]) + # self.surfaces[i] = cr.get_target() + else: + print 'sprite.draw: source not a pixbuf (%s)' % (type(img)) + cr.rectangle(self.rect.x + self._dx[i], + self.rect.y + self._dy[i], + self.rect.width, + self.rect.height) + cr.fill() + if len(self.labels) > 0: - self.draw_label() + self.draw_label(cr) def hit(self, pos): - """ Is (x, y) on top of the sprite? """ + ''' Is (x, y) on top of the sprite? ''' x, y = pos if x < self.rect.x: return False @@ -337,16 +360,18 @@ class Sprite: return False return True - def draw_label(self): - """ Draw the label based on its attributes """ - if self._sprites is None: - return + def draw_label(self, cr): + ''' Draw the label based on its attributes ''' + # Create a pangocairo context + cr = pangocairo.CairoContext(cr) my_width = self.rect.width - self._margins[0] - self._margins[2] if my_width < 0: my_width = 0 my_height = self.rect.height - self._margins[1] - self._margins[3] for i in range(len(self.labels)): - pl = self._sprites.canvas.create_pango_layout(str(self.labels[i])) + pl = cr.create_layout() + pl.set_text(str(self.labels[i])) + # pl = self._sprites.canvas.create_pango_layout(str(self.labels[i])) self._fd.set_size(int(self._scale[i] * pango.SCALE)) pl.set_font_description(self._fd) w = pl.get_size()[0] / pango.SCALE @@ -359,8 +384,8 @@ class Sprite: else: j = len(self.labels[i]) - 1 while(w > my_width and j > 0): - pl = self._sprites.canvas.create_pango_layout( - "…" + self.labels[i][len(self.labels[i]) - j:]) + pl.set_text( + "…" + self.labels[i][len(self.labels[i]) - j:]) self._fd.set_size(int(self._scale[i] * pango.SCALE)) pl.set_font_description(self._fd) w = pl.get_size()[0] / pango.SCALE @@ -369,44 +394,53 @@ class Sprite: x = int(self.rect.x + self._margins[0] + (my_width - w) / 2) elif self._horiz_align[i] == 'left': x = int(self.rect.x + self._margins[0]) - else: # right + else: # right x = int(self.rect.x + self.rect.width - w - self._margins[2]) h = pl.get_size()[1] / pango.SCALE if self._vert_align[i] == "middle": y = int(self.rect.y + self._margins[1] + (my_height - h) / 2) elif self._vert_align[i] == "top": y = int(self.rect.y + self._margins[1]) - else: # bottom + else: # bottom y = int(self.rect.y + self.rect.height - h - self._margins[3]) - self._sprites.gc.set_foreground(self._color) - self._sprites.area.draw_layout(self._sprites.gc, x, y, pl) + cr.save() + cr.translate(x, y) + cr.set_source_rgb(self._color[0], self._color[1], self._color[2]) + cr.update_layout(pl) + cr.show_layout(pl) + cr.restore() def label_width(self): - """ Calculate the width of a label """ - max = 0 - for i in range(len(self.labels)): - pl = self._sprites.canvas.create_pango_layout(self.labels[i]) - self._fd.set_size(int(self._scale[i] * pango.SCALE)) - pl.set_font_description(self._fd) - w = pl.get_size()[0] / pango.SCALE - if w > max: - max = w - return max + ''' Calculate the width of a label ''' + cr = pangocairo.CairoContext(self._sprites.cr) + if cr is not None: + max = 0 + for i in range(len(self.labels)): + pl = cr.create_layout() + pl.set_text(self.labels[i]) + self._fd.set_size(int(self._scale[i] * pango.SCALE)) + pl.set_font_description(self._fd) + w = pl.get_size()[0] / pango.SCALE + if w > max: + max = w + return max + else: + return self.rect.width def label_safe_width(self): - """ Return maximum width for a label """ + ''' Return maximum width for a label ''' return self.rect.width - self._margins[0] - self._margins[2] def label_safe_height(self): - """ Return maximum height for a label """ + ''' Return maximum height for a label ''' return self.rect.height - self._margins[1] - self._margins[3] def label_left_top(self): - """ Return the upper-left corner of the label safe zone """ + ''' Return the upper-left corner of the label safe zone ''' return(self._margins[0], self._margins[1]) def get_pixel(self, pos, i=0, mode='888'): - """ Return the pixel at (x, y) """ + ''' Return the pixel at (x, y) ''' x, y = pos x = x - self.rect.x y = y - self.rect.y @@ -452,3 +486,4 @@ class Sprite: g = g << 2 b = b << 3 return(r, g, b, 0) + |