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

Legend:
Removed from v.362  
changed lines
  Added in v.2431

[email protected]
ViewVC Help
Powered by ViewVC 1.1.26