From 8a8e606b5a6d1888f4a31a5afff490b4629ebc29 Mon Sep 17 00:00:00 2001
From: Walter Bender <walter.bender@gmail.com>
Date: Sun, 20 Nov 2011 19:46:23 +0000
Subject: convert to Cairo graphics

---
diff --git a/card.py b/card.py
index 31533be..c5e9a40 100644
--- a/card.py
+++ b/card.py
@@ -65,7 +65,7 @@ class Card:
         if self.orientation == 360:
             self.orientation = 0
         if rotate_spr is True:
-            self.spr.images[0] = self.images[int(self.orientation/90)]
+            self.spr.set_shape(self.images[int(self.orientation/90)])
         self.spr.draw()
 
     def print_card(self):
diff --git a/sprites.py b/sprites.py
index a361ba0..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,73 +73,94 @@ def svg_str_to_pixbuf(svg_string):
     pl.close()
     pixbuf = pl.get_pixbuf()
     return pixbuf
-"""
+
+'''
 
 import pygtk
 pygtk.require('2.0')
 import gtk
-import gobject
 import pango
-
-#
-# A class for the list of sprites and everything they share in common
-#
+import pangocairo
+import cairo
 
 class Sprites:
-    def __init__(self, canvas, area=None, gc=None):
-        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):
-        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? '''
         return(len(self.list))
 
     def append_to_list(self, spr):
+        ''' 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. '''
         if i < 0:
             self.list.insert(0, spr)
-        elif i > len(self.list)-1:
+        elif i > len(self.list) - 1:
             self.list.append(spr)
         else:
             self.list.insert(i, spr)
 
     def remove_from_list(self, spr):
+        ''' 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. '''
         list = self.list[:]
         list.reverse()
         for spr in list:
-            if spr.hit(pos): return spr
+            if spr.hit(pos):
+                return spr
         return None
 
-    def redraw_sprites(self):
+    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:
-            spr.draw()
+            if area == None:
+                spr.draw(cr=cr)
+            else:
+                intersection = spr.rect.intersect(area)
+                if intersection.width > 0 or intersection.height > 0:
+                    spr.draw(cr=cr)
+
 
-#
-# A class for the individual sprites
-#
 class Sprite:
+    ''' A class for the individual sprites '''
+
     def __init__(self, sprites, x, y, image):
+        ''' Initialize an individual sprite '''
         self._sprites = sprites
-        self._x = int(x)
-        self._y = int(y)
+        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"]
@@ -145,67 +169,82 @@ class Sprite:
         self._bold = False
         self._italic = False
         self._color = None
-        self._width = 0
-        self._height = 0
-        self._margins = [0,0,0,0]
+        self._margins = [0, 0, 0, 0]
         self.layer = 100
         self.labels = []
-        self.images = []
-        self._dx = [] # image offsets
+        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):
-        while len(self.images) < i+1:
-           self.images.append(None)
-           self._dx.append(0)
-           self._dy.append(0)
-        self.images[i] = image
+        ''' 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._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()
-        if i == 0: # Always reset width and height when base image changes.
-            self._width = _w + dx
-            self._height = _h + dy
+            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
         else:
-            if _w + dx > self._width:
-                self._width = _w + dx
-            if _h + dy > self._height:
-                self._height = _h + dy
+            if w + dx > self.rect.width:
+                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 '''
         self.inval()
-        self._x,self._y = int(pos[0]),int(pos[1])
+        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 '''
         self.inval()
-        self._x += int(pos[0])
-        self._y += int(pos[1])
+        self.rect.x += int(pos[0])
+        self.rect.y += int(pos[1])
         self.inval()
 
     def get_xy(self):
-        return (self._x, self._y)
+        ''' Return current (x, y) position '''
+        return (self.rect.x, self.rect.y)
 
     def get_dimensions(self):
-        return (self._width, self._height)
+        ''' Return current size '''
+        return (self.rect.width, self.rect.height)
 
     def get_layer(self):
+        ''' Return current layer '''
         return self.layer
 
     def set_shape(self, image, i=0):
+        ''' Set the current image associated with the sprite '''
         self.inval()
         self.set_image(image, i)
         self.inval()
 
-    def set_layer(self, layer):
+    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)
@@ -215,37 +254,54 @@ class Sprite:
         self.inval()
 
     def set_label(self, new_label, i=0):
+        ''' 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
-            self.labels[i] = new_label.replace("\0"," ")
+            self.labels[i] = new_label.replace("\0", " ")
         else:
             self.labels[i] = str(new_label)
         self.inval()
 
     def set_margins(self, l=0, t=0, r=0, b=0):
-        self._margins = [l,t,r,b]
+        ''' 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 '''
         if self._fd is None:
-           self.set_font('Sans')
+            self.set_font('Sans')
         if self._color is None:
-           self._color = self._sprites.cm.alloc_color('black')
-        while len(self.labels) < i+1:
-           self.labels.append(" ")
-           self._scale.append(self._scale[0])
-           self._rescale.append(self._rescale[0])
-           self._horiz_align.append(self._horiz_align[0])
-           self._vert_align.append(self._vert_align[0])
+            self._color = (0., 0., 0.)
+        while len(self.labels) < i + 1:
+            self.labels.append(" ")
+            self._scale.append(self._scale[0])
+            self._rescale.append(self._rescale[0])
+            self._horiz_align.append(self._horiz_align[0])
+            self._vert_align.append(self._vert_align[0])
 
     def set_font(self, font):
+        ''' Set the font for a label '''
         self._fd = pango.FontDescription(font)
 
     def set_label_color(self, rgb):
-        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 '''
         self._extend_labels_array(i)
         self._scale[i] = scale
         self._rescale[i] = rescale
@@ -253,114 +309,146 @@ class Sprite:
         self._vert_align[i] = vert_align
 
     def hide(self):
+        ''' Hide a sprite '''
         self.inval()
         self._sprites.remove_from_list(self)
 
+    def restore(self):
+        ''' Restore a hidden sprite '''
+        self.set_layer()
+
     def inval(self):
-        self._sprites.area.invalidate_rect(
-            gtk.gdk.Rectangle(self._x,self._y,self._width,self._height), False)
-
-    def draw(self):
-        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._x+self._dx[i],
-                                                 self._y+self._dy[i])
-            elif img is not None:
-                self._sprites.area.draw_drawable(
-                    self._sprites.gc, img, 0, 0, self._x+self._dx[i],
-                                                 self._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? '''
         x, y = pos
-        if x < self._x:
+        if x < self.rect.x:
             return False
-        if x > self._x+self._width:
+        if x > self.rect.x + self.rect.width:
             return False
-        if y < self._y:
+        if y < self.rect.y:
             return False
-        if y > self._y+self._height:
+        if y > self.rect.y + self.rect.height:
             return False
         return True
 
-    def draw_label(self):
-        my_width = self._width-self._margins[0]-self._margins[2]
+    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._height-self._margins[1]-self._margins[3]
+        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]))
-            self._fd.set_size(int(self._scale[i]*pango.SCALE))
+            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
+            w = pl.get_size()[0] / pango.SCALE
             if w > my_width:
-                if self._rescale[i] is True:
+                if self._rescale[i]:
                     self._fd.set_size(
-                                    int(self._scale[i]*pango.SCALE*my_width/w))
+                            int(self._scale[i] * pango.SCALE * my_width / w))
                     pl.set_font_description(self._fd)
-                    w = pl.get_size()[0]/pango.SCALE
+                    w = pl.get_size()[0] / pango.SCALE
                 else:
-                    j = len(self.labels[i])-1
+                    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:])
-                        self._fd.set_size(int(self._scale[i]*pango.SCALE))
+                        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        
+                        w = pl.get_size()[0] / pango.SCALE
                         j -= 1
             if self._horiz_align[i] == "center":
-                x = int(self._x+self._margins[0]+(my_width-w)/2)
+                x = int(self.rect.x + self._margins[0] + (my_width - w) / 2)
             elif self._horiz_align[i] == 'left':
-                x = int(self._x+self._margins[0])
+                x = int(self.rect.x + self._margins[0])
             else: # right
-                x = int(self._x+self._width-w-self._margins[2])
-            h = pl.get_size()[1]/pango.SCALE
+                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._y+self._margins[1]+(my_height-h)/2)
+                y = int(self.rect.y + self._margins[1] + (my_height - h) / 2)
             elif self._vert_align[i] == "top":
-                y = int(self._y+self._margins[1])
+                y = int(self.rect.y + self._margins[1])
             else: # bottom
-                y = int(self._y+self._height-h-self._margins[3])
-            self._sprites.gc.set_foreground(self._color)
-            self._sprites.area.draw_layout(self._sprites.gc, x, y, pl)
+                y = int(self.rect.y + self.rect.height - h - self._margins[3])
+            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):
-        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 self._width-self._margins[0]-self._margins[2]
-    
+        ''' Return maximum width for a label '''
+        return self.rect.width - self._margins[0] - self._margins[2]
+
     def label_safe_height(self):
-        return self._height-self._margins[1]-self._margins[3]
-    
+        ''' Return maximum height for a label '''
+        return self.rect.height - self._margins[1] - self._margins[3]
+
     def label_left_top(self):
-        return (self._margins[0], self._margins[1])
+        ''' Return the upper-left corner of the label safe zone '''
+        return(self._margins[0], self._margins[1])
 
     def get_pixel(self, pos, i=0):
-        x, y = pos
-        x = x-self._x
-        y = y-self._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 (-1,-1,-1,-1)
+        ''' 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)
+
diff --git a/window.py b/window.py
index 60f6309..e72fe5a 100644
--- a/window.py
+++ b/window.py
@@ -144,10 +144,21 @@ def distance(start,stop):
 #
 # Repaint
 #
-def _expose_cb(win, event, tw):
-    tw.sprites.redraw_sprites()
+def _expose_cb(tw, win, event):
+    ''' Callback to handle window expose events '''
+    tw.do_expose_event(event)
     return True
 
+def do_expose_event(tw, event):
+    ''' Handle the expose-event by drawing '''
+    # Restrict Cairo to the exposed area
+    cr = tw.canvas.window.cairo_create()
+    cr.rectangle(event.area.x, event.area.y,
+                 event.area.width, event.area.height)
+    cr.clip()
+    # Refresh sprite list
+    tw.sprites.redraw_sprites(cr=cr)
+
 #
 # callbacks
 #
--
cgit v0.9.1