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

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

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

revision 686 by bh, Wed Apr 16 13:22:25 2003 UTC revision 2537 by jonathan, Fri Jan 21 14:01:25 2005 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001, 2002, 2003 by Intevation GmbH  # Copyright (c) 2001-2004 by Intevation GmbH
2  # Authors:  # Authors:
3  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]> (2001-2003)
4  # Jonathan Coles <[email protected]>  # Jonathan Coles <[email protected]> (2003)
5    # Frank Koormann <[email protected]> (2003)
6    # Jan-Oliver Wagner <[email protected]> (2003, 2004)
7  #  #
8  # This program is free software under the GPL (>=v2)  # This program is free software under the GPL (>=v2)
9  # Read the file COPYING coming with Thuban for details.  # Read the file COPYING coming with Thuban for details.
10    
11  __version__ = "$Revision$"  from __future__ import generators
12    
13  from wxPython.wx import wxPoint, wxPen, wxBrush, wxFont, \  __version__ = "$Revision$"
14       wxTRANSPARENT_PEN, wxTRANSPARENT_BRUSH, \  # $Source$
15       wxBLACK, wxSOLID, wxCROSS_HATCH, wxSWISS, wxNORMAL  # $Id$
16    
17  from wxproj import draw_polygon_shape, draw_polygon_init  import cStringIO
18    
19  from Thuban import _  from Thuban import _
 from Thuban.UI.common import *  
   
 from Thuban.Model.layer import SHAPETYPE_POLYGON, SHAPETYPE_ARC, \  
      SHAPETYPE_POINT  
 from Thuban.Model.label import ALIGN_CENTER, ALIGN_TOP, ALIGN_BOTTOM, \  
      ALIGN_LEFT, ALIGN_RIGHT, ALIGN_BASELINE  
   
 from Thuban.Model.classification import Classification  
 from Thuban.Model.color import Color  
   
20    
21  class MapRenderer:  from wxPython.wx import wxPoint, wxRect, wxPen, wxBrush, wxFont, \
22        wxTRANSPARENT_PEN, wxTRANSPARENT_BRUSH, \
23        wxBLACK_PEN, wxBLACK, wxSOLID, wxCROSS_HATCH, wxSWISS, wxNORMAL, \
24        wxBitmapFromImage, wxImageFromStream, wxBITMAP_TYPE_BMP, \
25        wxBITMAP_TYPE_JPEG, wxBITMAP_TYPE_PNG, wxBITMAP_TYPE_TIF, \
26        wxBITMAP_TYPE_GIF, wxEmptyImage
27    
28      """Class to render a map onto a wxDC"""  from wxproj import draw_polygon_shape, draw_polygon_init
   
     honor_visibility = 1  
   
     def __init__(self, dc, scale, offset, resolution = 72.0,  
                  honor_visibility = None):  
         """Inititalize the renderer.  
   
         dc -- the wxPython DC to render on  
         scale, offset -- the scale factor and translation to convert  
                 between projected coordinates and the DC coordinates  
   
         resolution -- the assumed resolution of the DC. Used to convert  
                 absolute lengths like font sizes to DC coordinates  
   
         honor_visibility -- boolean. If true, honor the visibility flag  
                 of the layers, otherwise draw all layers. If None, use  
                 the renderer's default.  
         """  
         # resolution in pixel/inch  
   
         assert scale > 0  
   
         self.dc = dc  
         self.scale = scale  
         self.offset = offset  
         if honor_visibility is not None:  
             self.honor_visibility = honor_visibility  
         # store the resolution in pixel/point because it's more useful  
         # later.  
         self.resolution = resolution / 72.0  
   
     def render_map(self, map):  
         self.map = map  
         for layer in map.Layers():  
             # if honor_visibility is true, only draw visible layers,  
             # otherwise draw all layers  
             if not self.honor_visibility or layer.Visible():  
                 self.draw_shape_layer(layer)  
         self.draw_label_layer(map.LabelLayer())  
   
     def draw_shape_layer(self, layer):  
         scale = self.scale  
         offx, offy = self.offset  
29    
30          map_proj = self.map.projection  from Thuban.UI.common import Color2wxColour
31          layer_proj = layer.projection  from Thuban.UI.classifier import ClassDataPreviewer
32    from Thuban.UI.scalebar import ScaleBar
33    
34          shapetype = layer.ShapeType()  from Thuban.Model.data import SHAPETYPE_POLYGON, SHAPETYPE_ARC, \
35         SHAPETYPE_POINT, RAW_SHAPEFILE
36    
37          brush = wxTRANSPARENT_BRUSH  from Thuban.Model.color import Transparent
38          pen   = wxTRANSPARENT_PEN  import Thuban.Model.resource
39    
40          old_prop = None  from baserenderer import BaseRenderer
         lc = layer.GetClassification()  
         field = lc.GetField()  
   
   
         if shapetype != SHAPETYPE_POINT:  
             polygon_render_param = self.polygon_render_param(layer)  
   
         for i in self.layer_ids(layer):  
             value = None  
   
             if field is not None:  
                 try:  
                     record = layer.table.read_record(i)  
                     if record is not None:  
                         value = record[field]  
                 except:  
                     pass  
   
                 #  
                 # if the above statements fail 'value' should  
                 # be null, at which point this call will  
                 # at least retreive the NullData  
                 #  
41    
42                  group = lc.FindGroup(value)  from math import floor
   
                 #prop = lc.GetProperties(value)  
             else:  
                 group = lc.GetDefaultGroup()  
43    
44    from types import StringType
45    
             if not group.IsVisible():  
                 continue  
46    
47              prop = group.GetProperties()  # Map the strings used for the format parameter of the draw_raster_data
48    # method to the appropriate wxWindows constants
49    raster_format_map = {
50        "BMP": wxBITMAP_TYPE_BMP,
51        "JPEG": wxBITMAP_TYPE_JPEG,
52        "PNG": wxBITMAP_TYPE_PNG,
53        "TIFF": wxBITMAP_TYPE_TIF,
54        "GIF": wxBITMAP_TYPE_GIF,
55        }
56    
57              # don't recreate new objects if they are the same as before  class MapRenderer(BaseRenderer):
             if prop != old_prop:  
                 old_prop = prop  
   
                 if shapetype == SHAPETYPE_ARC:  
                     fill = Color.Transparent  
                 else:  
                     fill = prop.GetFill()  
58    
59        """Class to render a map onto a wxDC"""
60    
61                  if fill is Color.Transparent:      TRANSPARENT_PEN = wxTRANSPARENT_PEN
62                      brush = wxTRANSPARENT_BRUSH      TRANSPARENT_BRUSH = wxTRANSPARENT_BRUSH
                 else:  
                     color = Color2wxColour(fill)  
                     brush = wxBrush(color, wxSOLID)  
63    
64                  stroke = prop.GetLineColor()      def make_point(self, x, y):
65                  stroke_width = prop.GetLineWidth()          return wxPoint(int(round(x)), int(round(y)))
                 if stroke is Color.Transparent:  
                     pen = wxTRANSPARENT_PEN  
                 else:  
                     color = Color2wxColour(stroke)  
                     pen = wxPen(color, stroke_width, wxSOLID)  
66    
67        def tools_for_property(self, prop):
68            fill = prop.GetFill()
69            if fill is Transparent:
70                brush = self.TRANSPARENT_BRUSH
71            else:
72                brush = wxBrush(Color2wxColour(fill), wxSOLID)
73    
74              if shapetype == SHAPETYPE_POINT:          stroke = prop.GetLineColor()
75                  self.dc.SetBrush(brush)          if stroke is Transparent:
76                  self.dc.SetPen(pen)              pen = self.TRANSPARENT_PEN
77                  self.draw_point_shape(layer, i)          else:
78              else:              pen = wxPen(Color2wxColour(stroke), prop.GetLineWidth(), wxSOLID)
79                  self.draw_polygon_shape(polygon_render_param, i, pen, brush)          return pen, brush
80    
81      def layer_ids(self, layer):      def low_level_renderer(self, layer):
82          """Return the shape ids of the given layer that have to be drawn.          """Override inherited method to provide more efficient renderers
83    
84          The default implementation simply returns all ids in the layer.          If the underlying data format is not a shapefile or the layer
85          Override in derived classes to be more precise.          contains points shapes, simply use what the inherited method
86            returns.
87    
88            Otherwise, i.e. for arc and polygon use the more efficient
89            wxproj.draw_polygon_shape and its corresponding parameter
90            created with wxproj.draw_polygon_init.
91          """          """
92          return range(layer.NumShapes())          if (layer.ShapeStore().RawShapeFormat() == RAW_SHAPEFILE
93                and layer.ShapeType() in (SHAPETYPE_ARC, SHAPETYPE_POLYGON)):
94      def polygon_render_param(self, layer):              offx, offy = self.offset
95          """Return the low-lever render parameter for the layer"""              return (True, draw_polygon_shape,
96          offx, offy = self.offset                      draw_polygon_init(layer.ShapeStore().Shapefile(),
97          return draw_polygon_init(layer.shapefile, self.dc,                                        self.dc, self.map.projection,
98                                   self.map.projection,                                        layer.projection,
99                                   layer.projection,                                        self.scale, -self.scale, offx, offy))
                                  self.scale, -self.scale,  
                                  offx, offy)  
   
     def draw_polygon_shape(self, draw_polygon_info, index, pen, brush):  
         draw_polygon_shape(draw_polygon_info, index, pen, brush)  
   
     def projected_points(self, layer, index):  
         proj = self.map.projection  
         if proj is not None:  
             forward = proj.Forward  
100          else:          else:
101              forward = None              return BaseRenderer.low_level_renderer(self, layer)
         proj = layer.projection  
         if proj is not None:  
             inverse = proj.Inverse  
         else:  
             inverse = None  
         shape = layer.Shape(index)  
         points = []  
         scale = self.scale  
         offx, offy = self.offset  
         for x, y in shape.Points():  
             if inverse:  
                 x, y = inverse(x, y)  
             if forward:  
                 x, y = forward(x, y)  
             points.append(wxPoint(x * scale + offx,  
                                   -y * scale + offy))  
         return points  
   
     def draw_arc_shape(self, layer, index):  
         points = self.projected_points(layer, index)  
         self.dc.DrawLines(points)  
   
     def draw_point_shape(self, layer, index):  
         pp = self.projected_points(layer, index)  
   
         if len(pp) == 0: return # ignore Null Shapes which have no points  
   
         p = pp[0]  
         radius = self.resolution * 5  
         self.dc.DrawEllipse(p.x - radius, p.y - radius, 2*radius, 2*radius)  
102    
103      def draw_label_layer(self, layer):      def label_font(self):
104          scale = self.scale          return wxFont(int(round(self.resolution * 10)), wxSWISS, wxNORMAL,
105          offx, offy = self.offset                        wxNORMAL)
106    
107        def draw_raster_data(self, x,y, data, format = 'BMP', mask = None):
108            if format == 'RAW':
109                image = wxEmptyImage(data[0], data[1])
110                image.SetData(data[2])
111            else:
112                stream = cStringIO.StringIO(data[2])
113                image = wxImageFromStream(stream, raster_format_map[format])
114    
115          font = wxFont(self.resolution * 10, wxSWISS, wxNORMAL, wxNORMAL)          bitmap = wxBitmapFromImage(image)
         self.dc.SetFont(font)  
116    
117          map_proj = self.map.projection          if mask is None:
118          if map_proj is not None:              self.dc.DrawBitmap(bitmap, int(round(x)), int(round(y)), False)
             forward = map_proj.Forward  
119          else:          else:
120              forward = None              # if we are given a mask object, try to pass it to SetMaskColour,
121                # otherwise assume it's a mask image
122          for label in layer.Labels():              try:
123              x = label.x                  bitmap.SetMaskColour(mask);
124              y = label.y                  self.dc.DrawBitmap(bitmap, int(round(x)), int(round(y)), True)
125              text = label.text              except (TypeError):
126              if forward:                  # implement using a mask image
127                  x, y = forward(x, y)                  raise NotImplementedError
             x = x * scale + offx  
             y = -y * scale + offy  
             width, height = self.dc.GetTextExtent(text)  
             if label.halign == ALIGN_LEFT:  
                 # nothing to be done  
                 pass  
             elif label.halign == ALIGN_RIGHT:  
                 x = x - width  
             elif label.halign == ALIGN_CENTER:  
                 x = x - width/2  
             if label.valign == ALIGN_TOP:  
                 # nothing to be done  
                 pass  
             elif label.valign == ALIGN_BOTTOM:  
                 y = y - height  
             elif label.valign == ALIGN_CENTER:  
                 y = y - height/2  
             self.dc.DrawText(text, x, y)  
128    
129    
130  class ScreenRenderer(MapRenderer):  class ScreenRenderer(MapRenderer):
131    
132      # On the screen we want to see only visible layers by default      # On the screen we want to see only visible layers by default
133      honor_visibility = 1      honor_visibility = 1
134        
135      def RenderMap(self, map, region, selected_layer, selected_shapes):      def RenderMap(self, selected_layer, selected_shapes):
136          """Render the map.          """Render the map.
137    
138          Only the given region (a tuple in window coordinates as returned          Only the given region (a tuple in window coordinates as returned
# Line 259  class ScreenRenderer(MapRenderer): Line 140  class ScreenRenderer(MapRenderer):
140          shapes given by the ids in selected_shapes in the          shapes given by the ids in selected_shapes in the
141          selected_layer.          selected_layer.
142          """          """
         self.update_region = region  
143          self.selected_layer = selected_layer          self.selected_layer = selected_layer
144          self.selected_shapes = selected_shapes          self.selected_shapes = selected_shapes
145          self.render_map(map)          self.render_map()
146    
147      def draw_shape_layer(self, layer):      def RenderMapIncrementally(self):
148          MapRenderer.draw_shape_layer(self, layer)          """Render the map.
149          if layer is self.selected_layer and self.selected_shapes:  
150              pen = wxPen(wxBLACK, 3, wxSOLID)          Only the given region (a tuple in window coordinates as returned
151              brush = wxBrush(wxBLACK, wxCROSS_HATCH)          by a wxrect's asTuple method) needs to be redrawn. Highlight the
152            shapes given by the ids in selected_shapes in the
153              shapetype = layer.ShapeType()          selected_layer.
154              if shapetype == SHAPETYPE_POLYGON:          """
155                  offx, offy = self.offset          return self.render_map_incrementally()
156                  renderparam = self.polygon_render_param(layer)  
157                  func = self.draw_polygon_shape      def draw_selection_incrementally(self, layer, selected_shapes):
158                  args = (pen, brush)          """Draw the selected shapes in a emphasized way (i.e.
159              elif shapetype == SHAPETYPE_ARC:          with a special pen and brush.
160                  renderparam = self.polygon_render_param(layer)          The drawing is performed incrementally, that means every
161                  func = self.draw_polygon_shape          n shapes, the user can have interactions with the map.
162                  args = (pen, None)          n is currently fixed to 500.
163              elif shapetype == SHAPETYPE_POINT:  
164                  renderparam = layer          layer -- the layer where the shapes belong to.
165                  self.dc.SetBrush(brush)          selected_shapes -- a list of the shape-ids representing the
166                  self.dc.SetPen(pen)                             selected shapes for the given layer.
167                  func = self.draw_point_shape          """
168                  args = ()          pen = wxPen(wxBLACK, 3, wxSOLID)
169              else:          brush = wxBrush(wxBLACK, wxCROSS_HATCH)
                 raise TypeError(_("Unhandled shape type %s") % shapetype)  
170    
171              for index in self.selected_shapes:          shapetype = layer.ShapeType()
172                  func(renderparam, index, *args)          useraw, func, param = self.low_level_renderer(layer)
173            args = (pen, brush)
174    
175            # for point shapes we need to find out the properties
176            # to determine the size. Based on table and field,
177            # we can find out the properties for object - see below.
178            if shapetype == SHAPETYPE_POINT:
179                lc = layer.GetClassification()
180                field = layer.GetClassificationColumn()
181                table = layer.ShapeStore().Table()
182    
183            count = 0
184            for index in selected_shapes:
185                count += 1
186                shape = layer.Shape(index)
187    
188                # Get the size of the specific property for this
189                # point
190                if shapetype == SHAPETYPE_POINT and field is not None:
191                    value = table.ReadValue(shape.ShapeID(), field)
192                    group = lc.FindGroup(value)
193                    size = group.GetProperties().GetSize()
194                    args = (pen, brush, size)
195    
196      def layer_ids(self, layer):              if useraw:
197                    data = shape.RawData()
198                else:
199                    data = shape.Points()
200                func(param, data, *args)
201                if count % 500 == 0:
202                    yield True
203    
204        def layer_shapes(self, layer):
205          """Return the shapeids covered by the region that has to be redrawn          """Return the shapeids covered by the region that has to be redrawn
206    
207          Call the layer's ShapesInRegion method to determine the ids so          Call the layer's ShapesInRegion method to determine the ids so
# Line 314  class ScreenRenderer(MapRenderer): Line 222  class ScreenRenderer(MapRenderer):
222          offx, offy = self.offset          offx, offy = self.offset
223          xs = []          xs = []
224          ys = []          ys = []
225          x, y, width, height = self.update_region          x, y, width, height = self.region
226          for winx, winy in ((x, y), (x + width, y),          for winx, winy in ((x, y), (x + width, y),
227                             (x + width, y + height), (x, y + height)):                             (x + width, y + height), (x, y + height)):
228              px = (winx - offx) / scale              px = (winx - offx) / scale
# Line 331  class ScreenRenderer(MapRenderer): Line 239  class ScreenRenderer(MapRenderer):
239          return layer.ShapesInRegion((left, bottom, right, top))          return layer.ShapesInRegion((left, bottom, right, top))
240    
241    
242  class PrinterRender(MapRenderer):  class ExportRenderer(ScreenRenderer):
243    
244        honor_visibility = 1
245    
246        def __init__(self, *args, **kw):
247            """Initialize the ExportRenderer.
248    
249            In addition to all parameters of the the ScreenRender
250            constructor, this class requires and additional keyword argument
251            destination_region with a tuple (minx, miny, maxx, maxy) giving
252            the region in dc coordinates which is to contain the map.
253            """
254            self.destination_region = kw["destination_region"]
255            del kw["destination_region"]
256            ScreenRenderer.__init__(self, *args, **kw)
257    
258        def RenderMap(self, selected_layer, selected_shapes):
259            """Render the map.
260    
261            The rendering device has been specified during initialisation.
262            The device border distance was set in
263            Thuban.UI.viewport.output_transform().
264    
265            RenderMap renders a frame set (one page frame, one around
266            legend/scalebar and one around the map), the map, the legend and
267            the scalebar on the given DC. The map is rendered with the
268            region displayed in the canvas view, centered on the area
269            available for map display.
270            """
271    
272            self.selected_layer = selected_layer
273            self.selected_shapes = selected_shapes
274    
275            # Get some dimensions
276            llx, lly, urx, ury = self.region
277            mminx, mminy, mmaxx, mmaxy = self.destination_region
278    
279            # Manipulate the offset to position the map
280            offx, offy = self.offset
281            # 1. Shift to corner of map drawing area
282            offx = offx + mminx
283            offy = offy + mminy
284    
285            # 2. Center the map on the map drawing area:
286            # region identifies the region on the canvas view:
287            # center of map drawing area - half the size of region: rendering origin
288            self.shiftx = (mmaxx - mminx)*0.5 - (urx - llx)*0.5
289            self.shifty = (mmaxy - mminy)*0.5 - (ury - lly)*0.5
290    
291            self.offset = (offx+self.shiftx, offy+self.shifty)
292            self.region = (llx + self.shiftx, lly + self.shifty, urx, ury)
293    
294            # Draw the map
295            self.dc.BeginDrawing()
296            self.dc.DestroyClippingRegion()
297            self.dc.SetClippingRegion(mminx+self.shiftx, mminy+self.shifty,
298                                      urx, ury)
299            self.render_map()
300            self.dc.EndDrawing()
301    
302            # Draw the rest (frames, legend, scalebar)
303            self.dc.BeginDrawing()
304            self.dc.DestroyClippingRegion()
305    
306            # Force the font for Legend drawing
307            font = wxFont(self.resolution * 10, wxSWISS, wxNORMAL, wxNORMAL)
308            self.dc.SetFont(font)
309    
310            self.render_frame()
311            self.render_legend()
312            self.render_scalebar()
313            self.dc.EndDrawing()
314    
315        def render_frame(self):
316            """Render the frames for map and legend/scalebar."""
317    
318            dc = self.dc
319            dc.SetPen(wxBLACK_PEN)
320            dc.SetBrush(wxTRANSPARENT_BRUSH)
321    
322            # Dimension stuff
323            width, height = dc.GetSizeTuple()
324            mminx, mminy, mmaxx, mmaxy = self.destination_region
325    
326            # Page Frame
327            dc.DrawRectangle(15,15,width-30, (mmaxy-mminy)+10)
328    
329            # Map Frame
330            llx, lly, urx, ury = self.region
331            dc.DrawRectangle(mminx + self.shiftx, mminy + self.shifty, urx, ury)
332    
333            # Legend Frame
334            dc.DrawRectangle(mmaxx+10,mminy,(width-20) - (mmaxx+10), mmaxy-mminy)
335    
336            dc.DestroyClippingRegion()
337            dc.SetClippingRegion(mmaxx+10,mminy,
338                                 (width-20) - (mmaxx+10), mmaxy-mminy)
339    
340        def render_legend(self):
341            """Render the legend on the Map."""
342    
343            previewer = ClassDataPreviewer()
344            dc = self.dc
345            dc.SetPen(wxBLACK_PEN)
346            dc.SetBrush(wxTRANSPARENT_BRUSH)
347    
348            # Dimension stuff
349            width, height = dc.GetSizeTuple()
350            mminx, mminy, mmaxx, mmaxy = self.destination_region
351            textwidth, textheight = dc.GetTextExtent("0")
352            iconwidth  = textheight
353            iconheight = textheight
354            stepy = textheight+3
355            dx = 10
356            posx = mmaxx + 10 + 5   # 10 pix distance mapframe/legend frame,
357                                    # 5 pix inside legend frame
358            posy = mminy + 5        # 5 pix inside legend frame
359    
360            # Render the legend
361            dc.SetTextForeground(wxBLACK)
362            if self.map.HasLayers():
363                layers = self.map.Layers()[:]
364                layers.reverse()
365                for l in layers:
366                    if l.Visible():
367                        # Render title
368                        dc.DrawText(l.Title(), posx, posy)
369                        posy+=stepy
370                        if l.HasClassification():
371                            # Render classification
372                            clazz = l.GetClassification()
373                            shapeType = l.ShapeType()
374                            for g in clazz:
375                                if g.IsVisible():
376                                    previewer.Draw(dc,
377                                        wxRect(posx+dx, posy,
378                                               iconwidth, iconheight),
379                                        g.GetProperties(), shapeType)
380                                    dc.DrawText(g.GetDisplayText(),
381                                                posx+2*dx+iconwidth, posy)
382                                    posy+=stepy
383    
384        def render_scalebar(self):
385            """Render the scalebar."""
386    
387            scalebar = ScaleBar(self.map)
388    
389            # Dimension stuff
390            width, height = self.dc.GetSizeTuple()
391            mminx, mminy, mmaxx, mmaxy = self.destination_region
392    
393            # Render the scalebar
394            scalebar.DrawScaleBar(self.scale, self.dc,
395                                 (mmaxx+10+5, mmaxy-25),
396                                 ((width-15-5) - (mmaxx+10+5),20)
397                                )
398            # 10 pix between map and legend frame, 5 pix inside legend frame
399            # 25 pix from the legend frame bottom line
400            # Width: 15 pix from DC border, 5 pix inside frame, 10, 5 as above
401            # Height: 20
402    
403      # When printing we want to see all layers  class PrinterRenderer(ExportRenderer):
404      honor_visibility = 0  
405        # Printing as well as Export / Screen display only the visible layer.
406        honor_visibility = 1
407    
     RenderMap = MapRenderer.render_map  
       

Legend:
Removed from v.686  
changed lines
  Added in v.2537

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26