Cairo migration

1 files changed, 170 insertions, 116 deletions

diff --git a/sprites.py b/sprites.py
index 2364335..baae94f 100644
--- a/sprites.py
+++ b/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,24 +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
 
-        # 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>")
@@ -63,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')
@@ -70,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
+import cairo
 
 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 """
-        if i < 0 or i > len(self.list)-1:
+        ''' 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:
@@ -118,12 +121,12 @@ 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):
-        """ Search based on (x, y) position. Return the 'top/first' one. """
+        ''' Search based on (x, y) position. Return the 'top/first' one. '''
         list = self.list[:]
         list.reverse()
         for spr in list:
@@ -131,23 +134,32 @@ class Sprites:
                 return spr
         return None
 
-    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.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]
@@ -160,26 +172,26 @@ class Sprite:
         self._margins = [0, 0, 0, 0]
         self.layer = 100
         self.labels = []
-        self.images = []
+        self.cached_surfaces = []
         self._dx = []  # image offsets
         self._dy = []
+        self.type = None
         self.set_image(image)
         self._sprites.append_to_list(self)
 
     def set_image(self, image, i=0, dx=0, dy=0):
-        """ Add an image to the sprite. """
-        while len(self.images) < i + 1:
-            self.images.append(None)
+        ''' Add an image to the sprite. '''
+        while len(self.cached_surfaces) < i + 1:
+            self.cached_surfaces.append(None)
             self._dx.append(0)
             self._dy.append(0)
-        self.images[i] = image
         self._dx[i] = dx
         self._dy[i] = dy
-        if isinstance(self.images[i], gtk.gdk.Pixbuf):
-            w = self.images[i].get_width()
-            h = self.images[i].get_height()
+        if isinstance(image, gtk.gdk.Pixbuf):
+            w = image.get_width()
+            h = image.get_height()
         else:
-            w, h = self.images[i].get_size()
+            w, h = image.get_size()
         if i == 0:  # Always reset width and height when base image changes.
             self.rect.width = w + dx
             self.rect.height = h + dy
@@ -188,42 +200,51 @@ class Sprite:
                 self.rect.width = w + dx
             if h + dy > self.rect.height:
                 self.rect.height = h + dy
+        surface = cairo.ImageSurface(
+            cairo.FORMAT_ARGB32, self.rect.width, self.rect.height)
+        context = cairo.Context(surface)
+        context = gtk.gdk.CairoContext(context)
+        context.set_source_pixbuf(image, 0, 0)
+        context.rectangle(0, 0, self.rect.width, self.rect.height)
+        context.fill()
+        self.cached_surfaces[i] = surface
 
     def move(self, pos):
-        """ Move to new (x, y) position """
+        ''' Move to new (x, y) position '''
         self.inval()
         self.rect.x, self.rect.y = int(pos[0]), int(pos[1])
         self.inval()
 
     def move_relative(self, pos):
-        """ Move to new (x+dx, y+dy) position """
+        ''' Move to new (x+dx, y+dy) position '''
         self.inval()
         self.rect.x += int(pos[0])
         self.rect.y += int(pos[1])
         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 """
+    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)
@@ -233,7 +254,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
@@ -243,15 +264,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])
@@ -260,16 +281,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
@@ -277,31 +309,40 @@ class Sprite:
         self._vert_align[i] = vert_align
 
     def hide(self):
-        """ Hide a sprite """
+        ''' Hide a sprite '''
         self.inval()
         self._sprites.remove_from_list(self)
 
+    def restore(self):
+        ''' Restore a hidden sprite '''
+        self.set_layer()
+
     def inval(self):
-        """ Force a region redraw by gtk """
-        self._sprites.area.invalidate_rect(self.rect, False)
-
-    def draw(self):
-        """ Draw the sprite (and label) """
-        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)
+        ''' Invalidate a region for gtk '''
+        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
+        for i, surface in enumerate(self.cached_surfaces):
+            cr.set_source_surface(surface,
+                                  self.rect.x + self._dx[i],
+                                  self.rect.y + self._dy[i])
+            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
@@ -313,14 +354,17 @@ class Sprite:
             return False
         return True
 
-    def draw_label(self):
-        """ Draw the label based on its attributes """
+    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]))
             self._fd.set_size(int(self._scale[i] * pango.SCALE))
             pl.set_font_description(self._fd)
             w = pl.get_size()[0] / pango.SCALE
@@ -333,8 +377,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
@@ -352,49 +396,59 @@ class Sprite:
                 y = int(self.rect.y + self._margins[1])
             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):
-        """ Return the pixl at (x, y) """
-        x, y = pos
-        x = x - self.rect.x
-        y = y - self.rect.y
-        if y > self.images[i].get_height() - 1:
-            return(-1, -1, -1, -1)
-        try:
-            array = self.images[i].get_pixels()
-            if array is not None:
-                offset = (y * self.images[i].get_width() + x) * 4
-                r, g, b, a = ord(array[offset]), ord(array[offset + 1]),\
-                             ord(array[offset + 2]), ord(array[offset + 3])
-                return(r, g, b, a)
-            else:
-                return(-1, -1, -1, -1)
-        except IndexError:
-            print "Index Error: %d %d" % (len(array), offset)
+        ''' Return the pixel at (x, y) '''
+        x = int(pos[0] - self.rect.x)
+        y = int(pos[1] - self.rect.y)
+        if x < 0 or x > (self.rect.width - 1) or \
+                y < 0 or y > (self.rect.height - 1):
             return(-1, -1, -1, -1)
+
+        # create a new 1x1 cairo surface
+        cs = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1);
+        cr = cairo.Context(cs)
+        cr.set_source_surface(self.cached_surfaces[i], -x, -y)
+        cr.rectangle(0,0,1,1)
+        cr.set_operator(cairo.OPERATOR_SOURCE)
+        cr.fill()
+        cs.flush() # ensure all writing is done
+        # Read the pixel
+        pixels = cs.get_data()
+        return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0)
+