/[thuban]/branches/WIP-pyshapelib-bramz/Thuban/UI/baserenderer.py
ViewVC logotype

Diff of /branches/WIP-pyshapelib-bramz/Thuban/UI/baserenderer.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1554 by bh, Wed Aug 6 17:24:30 2003 UTC revision 2278 by bh, Tue Jul 13 11:07:45 2004 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001, 2002, 2003 by Intevation GmbH  # Copyright (c) 2001, 2002, 2003, 2004 by Intevation GmbH
2  # Authors:  # Authors:
3  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]>
4  # Jonathan Coles <[email protected]>  # Jonathan Coles <[email protected]>
# Line 14  be tested reasonably easily and it could Line 14  be tested reasonably easily and it could
14  renderers.  renderers.
15  """  """
16    
17    from __future__ import generators
18    
19  __version__ = "$Revision$"  __version__ = "$Revision$"
20  # $Source$  # $Source$
21  # $Id$  # $Id$
22    
23    import sys
24  import traceback  import traceback
25    
26  from Thuban.Model.layer import Layer, RasterLayer  from Thuban.Model.layer import Layer, RasterLayer
# Line 31  if Thuban.Model.resource.has_gdal_suppor Line 34  if Thuban.Model.resource.has_gdal_suppor
34      from gdalwarp import ProjectRasterFile      from gdalwarp import ProjectRasterFile
35    
36    
37    #
38    #       Renderer Extensions
39    #
40    # The renderer extensions provide a way to render layer types defined in
41    # Thuban extensions. The renderer extensions are stored as a list with
42    # (layer_class, draw_function) pairs. If the renderer has to draw a
43    # non-builtin layer type, i.e. a layer that is not a subclass of Layer
44    # or RasterLayer, it iterates through that list, tests whether the layer
45    # to be drawn is an instance of layer_class and if so calls
46    # draw_function with the renderer and the layer as arguments. Since
47    # drawing is done incrementally, the draw_function should return an
48    # iterable. The easiest way is to simply implement the draw_function as
49    # a generator and to yield in suitable places, or to return the empty
50    # tuple.
51    #
52    # New renderer extensions should be added with add_renderer_extension().
53    # If necessary the extensions list can be reset with
54    # init_renderer_extensions().
55    
56    _renderer_extensions = []
57    
58    def add_renderer_extension(layer_class, function):
59        """Add a renderer extension for the layer class layer_class
60    
61        When an instance of layer_class is to be drawn by the renderer the
62        renderer will call function with the renderer and the layer_class
63        instance as arguments. Since drawing is done incrementally, the
64        function should return an iterable. The easiest way is to simply
65        implement the draw_function as a generator and to yield True in
66        suitable places, or to return the empty tuple if it's not possible
67        to do the rendering incrementally.
68        """
69        _renderer_extensions.append((layer_class, function))
70    
71    def init_renderer_extensions():
72        """(Re)initialize the list of renderer extensions
73    
74        Calling this function outside of the test suite is probably not
75        useful.
76        """
77        del _renderer_extensions[:]
78    
79    
80    #
81    #       Base Renderer
82    #
83    
84  class BaseRenderer:  class BaseRenderer:
85    
86      """Basic Renderer Infrastructure for Thuban Maps      """Basic Renderer Infrastructure for Thuban Maps
# Line 49  class BaseRenderer: Line 99  class BaseRenderer:
99      TRANSPARENT_PEN = None      TRANSPARENT_PEN = None
100      TRANSPARENT_BRUSH = None      TRANSPARENT_BRUSH = None
101    
102      def __init__(self, dc, scale, offset, resolution = 72.0,      def __init__(self, dc, map, scale, offset, region = None,
103                   honor_visibility = None):                   resolution = 72.0, honor_visibility = None):
104          """Inititalize the renderer.          """Inititalize the renderer.
105    
106          dc -- the device context to render on.          dc -- the device context to render on.
# Line 58  class BaseRenderer: Line 108  class BaseRenderer:
108          scale, offset -- the scale factor and translation to convert          scale, offset -- the scale factor and translation to convert
109                  between projected coordinates and the DC coordinates                  between projected coordinates and the DC coordinates
110    
111            region -- The region to draw as a (x, y, width, height) tuple in
112                      the map's coordinate system. Default is None meaning
113                      to draw everything.
114    
115          resolution -- the assumed resolution of the DC. Used to convert          resolution -- the assumed resolution of the DC. Used to convert
116                  absolute lengths like font sizes to DC coordinates. The                  absolute lengths like font sizes to DC coordinates. The
117                  defauult is 72.0                  default is 72.0. If given, this parameter must be
118                    provided as a keyword argument.
119    
120          honor_visibility -- boolean. If true, honor the visibility flag          honor_visibility -- boolean. If true, honor the visibility flag
121                  of the layers, otherwise draw all layers. If None (the                  of the layers, otherwise draw all layers. If None (the
122                  default), use the renderer's default.                  default), use the renderer's default. If given, this
123                    parameter must be provided as a keyword argument.
124          """          """
125          # resolution in pixel/inch          # resolution in pixel/inch
   
126          self.dc = dc          self.dc = dc
127            self.map = map
128          self.scale = scale          self.scale = scale
129          self.offset = offset          self.offset = offset
130            self.region = region
131          if honor_visibility is not None:          if honor_visibility is not None:
132              self.honor_visibility = honor_visibility              self.honor_visibility = honor_visibility
133          # store the resolution in pixel/point because it's more useful          # store the resolution in pixel/point because it's more useful
# Line 85  class BaseRenderer: Line 142  class BaseRenderer:
142          """          """
143          raise NotImplementedError          raise NotImplementedError
144    
145      def render_map(self, map):      def render_map(self):
146          """Render the map onto the DC the renderer was instantiated with          """Render the map onto the DC.
147    
148            Both map and DC are the ones the renderer was instantiated with.
149    
150            This method is just a front-end for render_map_incrementally
151            which does all rendering in one go. It also calls the dc's
152            BeginDrawing and EndDrawing methods before and after calling
153            render_map_incrementally.
154            """
155    
156            self.dc.BeginDrawing()
157            try:
158                for cont in self.render_map_incrementally():
159                    pass
160            finally:
161                self.dc.EndDrawing()
162    
163        def render_map_incrementally(self):
164            """Render the map incrementally.
165    
166            Return an iterator whose next method should be called until it
167            returns False. After returning False it will raise StopIteration
168            so that you could also use it in a for loop (implementation
169            detail: this method is implemented as a generator).
170    
171          Iterate through all layers and draw them. Layers containing          Iterate through all layers and draw them. Layers containing
172          vector data are drawn with the draw_shape_layer method, raster          vector data are drawn with the draw_shape_layer method, raster
# Line 97  class BaseRenderer: Line 177  class BaseRenderer:
177          that methods especially in derived classes have access to the          that methods especially in derived classes have access to the
178          map if necessary.          map if necessary.
179          """          """
         # Some method have to have access to the map so we store it in  
         # self.map.  
         self.map = map  
   
180          # Whether the raster layer has already been drawn. See below for          # Whether the raster layer has already been drawn. See below for
181          # the optimization this is used for          # the optimization this is used for
182          seenRaster = True          seenRaster = True
183    
184          self.dc.BeginDrawing()          #
185            # This is only a good optimization if there is only one
186          try:          # raster layer and the image covers the entire window (as
187              #          # it currently does). We note if there is a raster layer
188              # This is only a good optimization if there is only one          # and only begin drawing layers once we have drawn it.
189              # raster layer and the image covers the entire window (as          # That way we avoid drawing layers that won't be seen.
190              # it currently does). We note if there is a raster layer          #
191              # and only begin drawing layers once we have drawn it.          if Thuban.Model.resource.has_gdal_support():
192              # That way we avoid drawing layers that won't be seen.              for layer in self.map.Layers():
193              #                  if isinstance(layer, RasterLayer) and layer.Visible():
194              if Thuban.Model.resource.has_gdal_support():                      seenRaster = False
195                  for layer in map.Layers():                      break
196                      if isinstance(layer, RasterLayer) and layer.Visible():  
197                          seenRaster = False          for layer in self.map.Layers():
198                          break              # if honor_visibility is true, only draw visible layers,
199                # otherwise draw all layers
200              for layer in map.Layers():              if not self.honor_visibility or layer.Visible():
201                  # if honor_visibility is true, only draw visible layers,                  if isinstance(layer, Layer):
202                  # otherwise draw all layers                      if seenRaster:
203                  if not self.honor_visibility or layer.Visible():                          for i in self.draw_shape_layer_incrementally(layer):
204                      if isinstance(layer, Layer) and seenRaster:                              yield True
205                          self.draw_shape_layer(layer)                  elif isinstance(layer, RasterLayer) \
206                      elif isinstance(layer, RasterLayer) \                      and Thuban.Model.resource.has_gdal_support():
207                          and Thuban.Model.resource.has_gdal_support():                      self.draw_raster_layer(layer)
208                          self.draw_raster_layer(layer)                      seenRaster = True
209                          seenRaster = True                      yield True
210                    else:
211                        # look it up in the renderer extensions
212                        for cls, func in _renderer_extensions:
213                            if isinstance(layer, cls):
214                                for i in func(self, layer):
215                                    yield True
216                                break
217                        else:
218                            # No renderer found. Print a message about it
219                            print >>sys.stderr, ("Drawing layer %r not supported"
220                                                 % layer)
221                yield True
222    
223              self.draw_label_layer(map.LabelLayer())          self.draw_label_layer(self.map.LabelLayer())
224          finally:          yield False
             self.dc.EndDrawing()  
225    
226      def draw_shape_layer(self, layer):      def draw_shape_layer_incrementally(self, layer):
227          """Draw the shape layer layer onto the map.          """Draw the shape layer layer onto the map incrementally.
228    
229          Automatically called by render_map. Iterate through all shapes          This method is a generator which yields True after every 500
230          as indicated by self.layer_ids() and draw them, using low-level          shapes.
         renderers returned by self.low_level_renderer().  
231          """          """
232          scale = self.scale          scale = self.scale
233          offx, offy = self.offset          offx, offy = self.offset
# Line 159  class BaseRenderer: Line 245  class BaseRenderer:
245          defaultGroup = lc.GetDefaultGroup()          defaultGroup = lc.GetDefaultGroup()
246          table = layer.ShapeStore().Table()          table = layer.ShapeStore().Table()
247    
248            if lc.GetNumGroups() == 0:
249                # There's only the default group, so we can pretend that
250                # there is no field to classifiy on which makes things
251                # faster since we don't need the attribute information at
252                # all.
253                field = None
254    
255          # Determine which render function to use.          # Determine which render function to use.
256          draw_func, draw_func_param = self.low_level_renderer(layer)          useraw, draw_func, draw_func_param = self.low_level_renderer(layer)
257    
258            #
259          # Iterate through all shapes that have to be drawn.          # Iterate through all shapes that have to be drawn.
260          for i in self.layer_ids(layer):          #
261    
262            # Count the shapes drawn so that we can yield every few hundred
263            # shapes
264            count = 0
265    
266            # Cache the tools (pens and brushes) for the classification
267            # groups. This is a mapping from the group's ids to the a tuple
268            # (pen, brush)
269            tool_cache = {}
270    
271            for shape in self.layer_shapes(layer):
272                count += 1
273              if field is None:              if field is None:
274                  group = defaultGroup                  group = defaultGroup
275              else:              else:
276                  record = table.ReadRowAsDict(i)                  value = table.ReadValue(shape.ShapeID(), field)
277                  assert record is not None                  group = lc.FindGroup(value)
                 group = lc.FindGroup(record[field])  
278    
279              if not group.IsVisible():              if not group.IsVisible():
280                  continue                  continue
281    
282              # don't recreate new objects if they are the same as before              try:
283              if group is not old_group:                  pen, brush = tool_cache[id(group)]
284                  old_group = group              except KeyError:
285                    pen, brush = tool_cache[id(group)] \
286                  prop = group.GetProperties()                               = self.tools_for_property(group.GetProperties())
287    
288                  if prop != old_prop:              if useraw:
289                      pen, brush = self.tools_for_property(prop)                  data = shape.RawData()
290                else:
291              draw_func(draw_func_param, i, pen, brush)                  data = shape.Points()
292                draw_func(draw_func_param, data, pen, brush)
293                if count % 500 == 0:
294                    yield True
295    
296      def layer_ids(self, layer):      def layer_shapes(self, layer):
297          """Return the shape ids of the given layer that have to be drawn.          """Return an iterable over the shapes to be drawn from the given layer.
298    
299          The default implementation simply returns all ids in the layer.          The default implementation simply returns all ids in the layer.
300          Override in derived classes to be more precise.          Override in derived classes to be more precise.
301          """          """
302          return range(layer.NumShapes())          return layer.ShapeStore().AllShapes()
303    
304      def low_level_renderer(self, layer):      def low_level_renderer(self, layer):
305          """Return the low-level renderer for the layer for draw_shape_layer          """Return the low-level renderer for the layer for draw_shape_layer
306    
307          The low level renderer to be returned by this method is a tuple          The low level renderer to be returned by this method is a tuple
308          (func, param) where func is a callable object and param is          (useraw, func, param) where useraw is a boolean indicating
309          passed as the first parameter to func. The draw_shape_layer          whether the function uses the raw shape data, func is a callable
310          method will call func like this:          object and param is passed as the first parameter to func. The
311            draw_shape_layer method will call func like this:
312              func(param, rawshape, pen, brush)  
313                func(param, shapedata, pen, brush)
314          where rawshape is currently the shapeid. pen and brush are the  
315          pen and brush to use to draw the shape on the dc.          where shapedata is the return value of the RawData method of the
316            shape object if useraw is true or the return value of the Points
317            method if it's false. pen and brush are the pen and brush to use
318            to draw the shape on the dc.
319    
320          The default implementation returns one of          The default implementation returns one of
321          self.draw_polygon_shape, self.draw_arc_shape or          self.draw_polygon_shape, self.draw_arc_shape or
322          self.draw_point_shape as func and layer as param. Derived          self.draw_point_shape as func and layer as param. None of the
323          classes can override this method to return more efficient low          method use the raw shape data. Derived classes can override this
324          level renderers.          method to return more efficient low level renderers.
325          """          """
326          shapetype = layer.ShapeType()          shapetype = layer.ShapeType()
327          if shapetype == SHAPETYPE_POINT:          if shapetype == SHAPETYPE_POINT:
# Line 220  class BaseRenderer: Line 330  class BaseRenderer:
330              func = self.draw_arc_shape              func = self.draw_arc_shape
331          else:          else:
332              func = self.draw_polygon_shape              func = self.draw_polygon_shape
333          return func, layer          return False, func, layer
334    
335      def make_point(self, x, y):      def make_point(self, x, y):
336          """Convert (x, y) to a point object.          """Convert (x, y) to a point object.
# Line 229  class BaseRenderer: Line 339  class BaseRenderer:
339          """          """
340          raise NotImplementedError          raise NotImplementedError
341    
342      def projected_points(self, layer, shapeid):      def projected_points(self, layer, points):
343          """Return the projected coordinates of shape shapeid in layer.          """Return the projected coordinates of the points taken from layer.
344    
345          Read the shape from the layer through its Shape method and          Transform all the points in the list of lists of coordinate
346          transform all the points in the list of lists of coordinate          pairs in points.
         pairs returned by the shape's Points method.  
347    
348          The transformation applies the inverse of the layer's projection          The transformation applies the inverse of the layer's projection
349          if any, then the map's projection if any and finally applies          if any, then the map's projection if any and finally applies
# Line 253  class BaseRenderer: Line 362  class BaseRenderer:
362              inverse = proj.Inverse              inverse = proj.Inverse
363          else:          else:
364              inverse = None              inverse = None
365          shape = layer.Shape(shapeid)          result = []
         points = []  
366          scale = self.scale          scale = self.scale
367          offx, offy = self.offset          offx, offy = self.offset
368          make_point = self.make_point          make_point = self.make_point
369          for part in shape.Points():          for part in points:
370              points.append([])              result.append([])
371              for x, y in part:              for x, y in part:
372                  if inverse:                  if inverse:
373                      x, y = inverse(x, y)                      x, y = inverse(x, y)
374                  if forward:                  if forward:
375                      x, y = forward(x, y)                      x, y = forward(x, y)
376                  points[-1].append(make_point(x * scale + offx,                  result[-1].append(make_point(x * scale + offx,
377                                               -y * scale + offy))                                               -y * scale + offy))
378          return points          return result
379    
380      def draw_polygon_shape(self, layer, index, pen, brush):      def draw_polygon_shape(self, layer, points, pen, brush):
381          """Draw a polygon shape with the given brush and pen          """Draw a polygon shape from layer with the given brush and pen
382    
383          The shape is indicated by its id (index) and the layer. The          The shape is given by points argument which is a the return
384          coordinates in the DC's coordinate system are determined with          value of the shape's Points() method. The coordinates in the
385            DC's coordinate system are determined with
386          self.projected_points.          self.projected_points.
387          """          """
388          points = self.projected_points(layer, index)          points = self.projected_points(layer, points)
389    
390          if brush is not self.TRANSPARENT_BRUSH:          if brush is not self.TRANSPARENT_BRUSH:
391              polygon = []              polygon = []
# Line 298  class BaseRenderer: Line 407  class BaseRenderer:
407              for part in points:              for part in points:
408                  self.dc.DrawLines(part)                  self.dc.DrawLines(part)
409    
410      def draw_arc_shape(self, layer, index, pen, brush):      def draw_arc_shape(self, layer, points, pen, brush):
411          """Draw an arc shape with the given brush and pen          """Draw an arc shape from layer with the given brush and pen
412    
413          The shape is indicated by its id (index) and the layer. The          The shape is given by points argument which is a the return
414          coordinates in the DC's coordinate system are determined with          value of the shape's Points() method. The coordinates in the
415            DC's coordinate system are determined with
416          self.projected_points.          self.projected_points.
417          """          """
418          points = self.projected_points(layer, index)          points = self.projected_points(layer, points)
419          self.dc.SetBrush(brush)          self.dc.SetBrush(brush)
420          self.dc.SetPen(pen)          self.dc.SetPen(pen)
421          for part in points:          for part in points:
422              self.dc.DrawLines(part)              self.dc.DrawLines(part)
423    
424      def draw_point_shape(self, layer, index, pen, brush):      def draw_point_shape(self, layer, points, pen, brush):
425          """Draw a point shape with the given brush and pen          """Draw a point shape from layer with the given brush and pen
426    
427          The shape is indicated by its id (index) and the layer. The          The shape is given by points argument which is a the return
428          coordinates in the DC's coordinate system are determined with          value of the shape's Points() method. The coordinates in the
429            DC's coordinate system are determined with
430          self.projected_points.          self.projected_points.
431    
432          The point is drawn as a circle centered on the point.          The point is drawn as a circle centered on the point.
433          """          """
434          points = self.projected_points(layer, index)          points = self.projected_points(layer, points)
435          if not points:          if not points:
436              return              return
437    
438          radius = self.resolution * 5          radius = int(round(self.resolution * 5))
439          self.dc.SetBrush(brush)          self.dc.SetBrush(brush)
440          self.dc.SetPen(pen)          self.dc.SetPen(pen)
441          for part in points:          for part in points:
# Line 372  class BaseRenderer: Line 483  class BaseRenderer:
483              # better.              # better.
484              traceback.print_exc()              traceback.print_exc()
485          else:          else:
486              self.draw_raster_data(data)              self.draw_raster_data(data, "BMP")
487    
488      def draw_raster_data(self, data):      def draw_raster_data(self, data, format="BMP"):
489          """Draw the raster image in data onto the DC          """Draw the raster image in data onto the DC
490    
491          The raster image data is a string holding the data in BMP          The raster image data is a string holding the data in the format
492          format. The data is exactly the size of the dc and covers it          indicated by the format parameter. The image is assumed to be
493          completely.          exactly the size of the dc and to cover it completely.
494    
495            The format parameter is a string with the name of the format.
496            The following format names should be used:
497    
498              'BMP' -- Windows Bitmap
499              'JPEG' -- Jpeg
500    
501            The default format is 'bmp'.
502    
503          This method has to be implemented by derived classes.          This method has to be implemented by derived classes. The
504            implementation in the derived class should try to support at
505            least the formats specified above and may support more.
506          """          """
507          raise NotImplementedError          raise NotImplementedError
508    
# Line 411  class BaseRenderer: Line 532  class BaseRenderer:
532              text = label.text              text = label.text
533              if forward:              if forward:
534                  x, y = forward(x, y)                  x, y = forward(x, y)
535              x = x * scale + offx              x = int(round(x * scale + offx))
536              y = -y * scale + offy              y = int(round(-y * scale + offy))
537              width, height = self.dc.GetTextExtent(text)              width, height = self.dc.GetTextExtent(text)
538              if label.halign == ALIGN_LEFT:              if label.halign == ALIGN_LEFT:
539                  # nothing to be done                  # nothing to be done
Legend:
Removed from v.1554  
changed lines
  Added in v.2278
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26