some support for path based clipping

jdh2358 · jdh2358 · commit ae347ec4a1d2 · 2007-03-19T01:38:42.000Z
svn path=/trunk/matplotlib/; revision=3092
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,5 @@
+2007-30-17 Preliminary support for clipping to paths agg - JDH
+
 2007-03-17 Text.set_text() accepts anything convertible with '%s' - EF
 
 2007-03-14 Add masked-array support to hist. - EF
diff --git a/agg23/include/agg_path_storage.h b/agg23/include/agg_path_storage.h
@@ -112,6 +112,7 @@ namespace agg
         void curve3(double x_ctrl, double y_ctrl, 
                     double x_to,   double y_to);
 
+
         void curve3_rel(double dx_ctrl, double dy_ctrl, 
                         double dx_to,   double dy_to);
 
diff --git a/examples/clippath_test.py b/examples/clippath_test.py
@@ -0,0 +1,23 @@
+from pylab import figure, show, nx
+from matplotlib.patches import RegularPolygon
+import matplotlib.agg as agg
+
+fig = figure()
+ax = fig.add_subplot(111)
+t = nx.arange(0.0, 4.0, 0.01)
+s = 2*nx.sin(2*nx.pi*8*t)
+line, = ax.plot(t, s)
+line2, = ax.plot(t, 0.5*s)
+line3, = ax.plot(t, 4*s)
+markers, = ax.plot(t, 2*(nx.mlab.rand(len(t))-0.5), 'bo')
+path = agg.path_storage()
+poly = RegularPolygon( (2, 0.), numVertices=8, radius=1.5)
+#for i, xy in enumerate(ax.transData.seq_xy_tups(poly.get_verts())):
+for i, xy in enumerate(ax.transData.seq_xy_tups(poly.get_verts())):
+    if i==0: path.move_to(*xy)
+    else:    path.line_to(*xy)
+path.close_polygon()
+line.set_clip_path(path)
+line2.set_clip_path(path)
+line3.set_clip_path(path)
+show()
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -36,6 +36,7 @@ def __init__(self):
         self._animated = False
         self._alpha = 1.0
         self.clipbox = None
+        self._clippath = None
         self._clipon = False
         self._lod = False
         self._label = ''
@@ -156,9 +157,20 @@ def set_clip_box(self, clipbox):
         ACCEPTS: a matplotlib.transform.Bbox instance
         """
         self.clipbox = clipbox
-        self._clipon = clipbox is not None
+        self._clipon = clipbox is not None or self._clippath is not None
         self.pchanged()
 
+    def set_clip_path(self, path):
+        """
+        Set the artist's clip path
+
+        ACCEPTS: an agg.path_storage instance
+        """
+        self._clippath = path
+        self._clipon = self.clipbox is not None or path is not None
+        self.pchanged()
+
+
     def get_alpha(self):
         """
         Return the alpha value used for blending - not supported on all
@@ -176,22 +188,34 @@ def get_animated(self):
 
     def get_clip_on(self):
         'Return whether artist uses clipping'
-        return self._clipon and self.clipbox is not None
+        return self._clipon and (self.clipbox is not None or self._clippath is not None)
 
     def get_clip_box(self):
         'Return artist clipbox'
         return self.clipbox
 
+    def get_clip_path(self):
+        'Return artist clip path'
+        return self._clippath
+
     def set_clip_on(self, b):
         """
         Set  whether artist uses clipping
 
         ACCEPTS: [True | False]
         """
         self._clipon = b
-        if not b: self.clipbox = None
+        if not b: 
+	    self.clipbox = None
+            self._clippath = None
         self.pchanged()
 
+    def _set_gc_clip(self, gc):
+        'set the clip properly for the gc'
+        if self.clipbox is not None:
+            gc.set_clip_rectangle(self.clipbox.get_bounds())
+        gc.set_clip_path(self._clippath)
+
     def draw(self, renderer, *args, **kwargs):
         'Derived classes drawing method'
         if not self.get_visible(): return
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -11,6 +11,7 @@
 import numerix.ma as ma
 
 import matplotlib.mlab
+import matplotlib.agg as agg
 import artist
 from artist import Artist, setp
 from axis import XAxis, YAxis
@@ -883,16 +884,8 @@ def get_child_artists(self):
         """
         Return a list of artists the axes contains.  Deprecated
         """
-        artists = [self.title, self.axesPatch, self.xaxis, self.yaxis]
-        artists.extend(self.lines)
-        artists.extend(self.patches)
-        artists.extend(self.texts)
-        artists.extend(self.collections)
-        artists.extend(self.images)        
-        if self.legend_ is not None:
-            artists.append(self.legend_)
-        return silent_list('Artist', artists)
-
+        raise DeprecationWarning('Use get_children instead')
+    
     def get_frame(self):
         'Return the axes Rectangle frame'
         return self.axesPatch
@@ -4967,7 +4960,7 @@ def _set_lim_and_transforms(self):
                              Point( Value(1/4.*math.pi), Value(math.sqrt(2))))
 
         self.transData = NonseparableTransformation(self.viewLim, self.bbox,
-                                                                  FuncXY(POLAR))
+                                                    FuncXY(POLAR))
         self.transAxes = get_bbox_transform(unit_bbox(), self.bbox)
 
 
@@ -5013,6 +5006,7 @@ def cla(self):
             edgecolor=rcParams['axes.edgecolor'],
             )
 
+        
         self.axesPatch.set_figure(self.figure)
         self.axesPatch.set_transform(self.transData)
         self.axesPatch.set_linewidth(rcParams['axes.linewidth'])
@@ -5035,16 +5029,35 @@ def cla(self):
         self.set_thetagrids(angles)
         self.set_rgrids(radii)
 
+    def get_children(self):
+        'return a list of child artists'
+        children = []
+        children.extend(self.rgridlines)
+        children.extend(self.rgridlabels)
+        children.extend(self.thetagridlines)
+        children.extend(self.thetagridlabels)
+        children.extend(self.lines)
+        children.extend(self.patches)
+        children.extend(self.texts)
+        children.extend(self.artists)
+        children.extend(self.images)
+        #if self.legend_ is not None:
+        #    children.append(self.legend_)
+        children.extend(self.collections)
+        children.append(self.title)
+        children.append(self.axesPatch)
+        return children
+
+
+    def set_rmax(self, rmax):
+        self.rintv.set_bounds(0, rmax)
+        self.regrid(rmax)
+        
     def grid(self, b):
         'Set the axes grids on or off; b is a boolean'
         self._gridOn = b
 
-    def autoscale_view(self, scalex=True, scaley=True):
-        'set the view limits to include all the data in the axes'
-        self.rintd.set_bounds(0, self.get_rmax())
-        rmin, rmax = self.rlocator.autoscale()
-        self.rintv.set_bounds(rmin, rmax)
-
+    def regrid(self, rmax):
         self.axesPatch.xy = zip(self.thetas, rmax*ones(self.RESOLUTION))
         val = rmax*math.sqrt(2)
         self.viewLim.intervaly().set_bounds(val, val)
@@ -5058,7 +5071,14 @@ def autoscale_view(self, scalex=True, scaley=True):
         r = linspace(0, rmax, self.RESOLUTION)
         for l in self.thetagridlines:
             l.set_ydata(r)
-
+        
+    def autoscale_view(self, scalex=True, scaley=True):
+        'set the view limits to include all the data in the axes'
+        self.rintd.set_bounds(0, self.get_rmax())
+        rmin, rmax = self.rlocator.autoscale()
+        self.rintv.set_bounds(rmin, rmax)
+        self.regrid(rmax)
+        
     def set_rgrids(self, radii, labels=None, angle=22.5, **kwargs):
         """
         set the radial locations and labels of the r grids
@@ -5182,14 +5202,38 @@ def draw(self, renderer):
         self.apply_aspect(1)
         self.transData.freeze()  # eval the lazy objects
         self.transAxes.freeze()  # eval the lazy objects
+
+        tverts = self.transData.seq_xy_tups(self.axesPatch.get_verts())
+
+        def make_clippath():
+            clippath = agg.path_storage()
+            for i, xy in enumerate(tverts):
+                if i==0: clippath.move_to(*xy)
+                else:    clippath.line_to(*xy)
+            clippath.close_polygon()
+            return clippath
+
+        clippath = agg.path_storage()
+        for i, xy in enumerate(tverts):
+            if i==0: clippath.move_to(*xy)
+            else:    clippath.line_to(*xy)
+        clippath.close_polygon()
+
         #self._update_axes()
         if self.axison:
             if self._frameon: self.axesPatch.draw(renderer)
 
         if self._gridOn:
             for l in self.rgridlines+self.thetagridlines:
+                #l.set_clip_path(make_clippath())
+                #l.set_clip_path(clippath)
                 l.draw(renderer)
 
+        for line in self.lines:
+            #line.set_clip_path(make_clippath())
+            #line.set_clip_path(clippath)
+            pass
+        
         for t in self.thetagridlabels+self.rgridlabels:
             t.draw(renderer)
 
@@ -5230,26 +5274,35 @@ def set_ylabel(self, ylabel, fontdict=None, **kwargs):
         raise NotImplementedError('ylabel not defined for polar axes (yet)')
 
 
-    def set_xlim(self, v, emit=True):
+    def set_xlim(self, xmin=None, xmax=None, emit=True):
         """
-        SET_XLIM(v, emit=True)
-
-        A do nothing impl until we can figure out how to handle interaction
+        set the xlimits
         ACCEPTS: len(2) sequence of floats
         """
-        #warnings.warn('Navigation set_ylim not implemented for polar')
-        self.viewLim.intervalx().set_bounds(*v)
+        if xmax is None and iterable(xmin):
+            xmin,xmax = xmin        
+
+        old_xmin,old_xmax = self.get_xlim()
+        if xmin is None: xmin = old_xmin
+        if xmax is None: xmax = old_xmax
+
+        self.viewLim.intervalx().set_bounds(xmin, xmax)
         if emit: self._send_xlim_event()
 
 
-    def set_ylim(self, v, emit=True):
+    def set_ylim(self, ymin=None, ymax=None, emit=True):
         """
-        SET_YLIM(v, emit=True)
-
+        set the ylimits
         ACCEPTS: len(2) sequence of floats
         """
-        #warnings.warn('Navigation set_xlim not implemented for polar')
-        self.viewLim.intervaly().set_bounds(*v)
+        if ymax is None and iterable(ymin):
+            ymin,ymax = ymin
+
+        old_ymin,old_ymax = self.get_ylim()
+        if ymin is None: ymin = old_ymin
+        if ymax is None: ymax = old_ymax
+
+        self.viewLim.intervaly().set_bounds(ymin, ymax)
         if emit: self._send_ylim_event()
 
     def get_xscale(self):
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -469,6 +469,7 @@ def __init__(self):
         self._antialiased = 1  # use 0,1 not True, False for extension code
         self._capstyle = 'butt'
         self._cliprect = None
+        self._clippath = None
         self._dashes = None, None
         self._joinstyle = 'miter'
         self._linestyle = 'solid'
@@ -482,6 +483,7 @@ def copy_properties(self, gc):
         self._antialiased = gc._antialiased
         self._capstyle = gc._capstyle
         self._cliprect = gc._cliprect
+        self._clippath = gc._clipath
         self._dashes = gc._dashes
         self._joinstyle = gc._joinstyle
         self._linestyle = gc._linestyle
@@ -512,6 +514,12 @@ def get_clip_rectangle(self):
         """
         return self._cliprect
 
+    def get_clip_path(self):
+        """
+        Return the clip path
+        """
+        return self._clipath
+
     def get_dashes(self):
         """
         Return the dash information as an offset dashlist tuple The
@@ -579,6 +587,12 @@ def set_clip_rectangle(self, rectangle):
         """
         self._cliprect = rectangle
 
+    def set_clip_path(self, path):
+        """
+        Set the clip path
+        """
+        self._clippath = path
+
     def set_dashes(self, dash_offset, dash_list):
         """
         Set the dash style for the gc.
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -379,13 +379,12 @@ def draw(self, renderer):
         if not self._visible: return
         self._newstyle = hasattr(renderer, 'draw_markers')
         gc = renderer.new_gc()
+        self._set_gc_clip(gc)
+        
         gc.set_foreground(self._color)
         gc.set_antialiased(self._antialiased)
         gc.set_linewidth(self._linewidth)
         gc.set_alpha(self._alpha)
-        if self.get_clip_on():
-            gc.set_clip_rectangle(self.clipbox.get_bounds())
-
         if self.is_dashed():
             cap = self._dashcapstyle
             join = self._dashjoinstyle
@@ -412,12 +411,15 @@ def draw(self, renderer):
         if self._segments is not None:
             for ii in self._segments:
                 lineFunc(renderer, gc, xt[ii[0]:ii[1]], yt[ii[0]:ii[1]])
+
         else:
             lineFunc(renderer, gc, xt, yt)
 
 
         if self._marker is not None:
+            
             gc = renderer.new_gc()
+            self._set_gc_clip(gc)
             if (is_string_like(self._markeredgecolor) and
                 self._markeredgecolor == 'auto'):
                 if self._marker in self.filled_markers:
@@ -427,8 +429,6 @@ def draw(self, renderer):
             else:
                 gc.set_foreground(self._markeredgecolor)
             gc.set_linewidth(self._markeredgewidth)
-            if self.get_clip_on():
-                gc.set_clip_rectangle(self.clipbox.get_bounds())
             funcname = self._markers.get(self._marker, '_draw_nothing')
             markerFunc = getattr(self, funcname)
             markerFunc(renderer, gc, xt, yt)
diff --git a/setup.py b/setup.py
@@ -71,7 +71,9 @@
 matplotlib requires setuptools for installation.  Please download
 http://peak.telecommunity.com/dist/ez_setup.py and run it (as su if
 you are doing a system wide install) to install the proper version of
-setuptools for your system""")
+setuptools for your system.  If this is your first time upgrading
+matplotlib with the new setuptools requirement, you must delete the
+old matplotlib install directory.""")
     
 import glob
 from distutils.core import Extension, setup
@@ -123,6 +125,7 @@
     raise RuntimeError("You must install one or more of numpy, Numeric, and numarray to build matplotlib")
 
 
+NUMERIX = ['numpy']
 rc['numerix'] = NUMERIX[-1]
 
 ext_modules = []
diff --git a/src/_backend_agg.cpp b/src/_backend_agg.cpp
diff --git a/src/_backend_agg.h b/src/_backend_agg.h

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+2007-30-17 Preliminary support for clipping to paths agg - JDH`
	`2`	`+`
`1`	`3`	`2007-03-17 Text.set_text() accepts anything convertible with '%s' - EF`
`2`	`4`
`3`	`5`	`2007-03-14 Add masked-array support to hist. - EF`