Thuban/Model/map.py

# Copyright (c) 2001, 2002 by Intevation GmbH
# Authors:
# Bernhard Herzog <[email protected]>
#
# This program is free software under the GPL (>=v2)
# Read the file COPYING coming with Thuban for details.

__version__ = "$Revision$"

#from messages import MAP_LAYERS_CHANGED, MAP_PROJECTION_CHANGED, \
     #CHANGED, LAYER_PROJECTION_CHANGED, LAYER_LEGEND_CHANGED, \
     #LAYER_VISIBILITY_CHANGED

from messages import *

from Thuban import _

from base import TitledObject, Modifiable

from label import LabelLayer


class Map(TitledObject, Modifiable):

    """Represent a map. A map is simply a list of layers.

    Map objects send the following message types:

        TITLE_CHANGED -- The title has changed. Parameter: the map.

        MAP_LAYERS_CHANGED -- Layers were added, removed or rearranged.
                        Parameters: the map

        MAP_PROJECTION_CHANGED -- the map's projection has changed.
                        Parameter: the map
    """

    forwarded_channels = (CHANGED,
                          LAYER_PROJECTION_CHANGED,
                          LAYER_LEGEND_CHANGED,
                          LAYER_CHANGED,
                          LAYER_VISIBILITY_CHANGED)

    def __init__(self, title, projection = None):
        """Initialize the map."""
        TitledObject.__init__(self, title)
        Modifiable.__init__(self)
        self.layers = []
        self.label_layer = LabelLayer(_("Labels"))
        self.label_layer.Subscribe(CHANGED, self.forward, MAP_LAYERS_CHANGED)
        self.projection = projection

    def Destroy(self):
        # call Modifiable.Destroy first since it will call
        # Publisher.Destroy which removes all subscriptions. Otherwise
        # clearing the layers results in messages to be sent which can
        # cause problems.
        Modifiable.Destroy(self)
        self.ClearLayers()
        self.label_layer.Unsubscribe(CHANGED, self.forward, MAP_LAYERS_CHANGED)
        self.label_layer.Destroy()

    def AddLayer(self, layer):
        """Append layer to the map on top opf all."""
        self.layers.append(layer)
        self.subscribe_layer_channels(layer)
        self.changed(MAP_LAYERS_CHANGED, self)
        self.changed(MAP_LAYERS_ADDED, self)

    def RemoveLayer(self, layer):
        """Remove layer from the map."""
        self.unsubscribe_layer_channels(layer)
        self.layers.remove(layer)
        self.changed(MAP_LAYERS_CHANGED, self)
        self.changed(MAP_LAYERS_REMOVED, self)
        layer.Destroy()

    def CanRemoveLayer(self, layer):
        """Return true if the layer can be deleted.

        The default implementation always returns 1. Derived classes
        should override this method if they have e.g. special layers
        that the user should not be able to remove.
        """
        return 1

    def ClearLayers(self):
        """Delete all layers."""
        for layer in self.layers:
            self.unsubscribe_layer_channels(layer)
            layer.Destroy()
        del self.layers[:]
        self.label_layer.ClearLabels()
        self.changed(MAP_LAYERS_CHANGED, self)
        self.changed(MAP_LAYERS_REMOVED, self)

    def subscribe_layer_channels(self, layer):
        """Subscribe to some of layer's channels."""
        for channel in self.forwarded_channels:
            layer.Subscribe(channel, self.forward, channel)

    def unsubscribe_layer_channels(self, layer):
        """Unsubscribe to some of layer's channels."""
        for channel in self.forwarded_channels:
            layer.Unsubscribe(channel, self.forward, channel)

    def LabelLayer(self):
        """Return the Map's label layer"""
        return self.label_layer

    def Layers(self):
        """Return the list of layers contained in the map.

        The list does not include the label layer"""
        return self.layers

    def HasLayers(self):
        """Return true if the map has at least one shape layer"""
        return len(self.layers) > 0

    def RaiseLayer(self, layer):
        """Swap the layer with the one above it.

        If the layer is already at the top do nothing. If the stacking
        order has been changed, issue a MAP_LAYERS_CHANGED message.
        """
        index = self.layers.index(layer)
        if index < len(self.layers) - 1:
            del self.layers[index]
            self.layers.insert(index + 1, layer)
            self.changed(MAP_LAYERS_CHANGED, self)
            self.changed(MAP_STACKING_CHANGED, self)

    def LowerLayer(self, layer):
        """Swap the layer with the one below it.

        If the layer is already at the bottom do nothing. If the
        stacking order has been changed, issue a MAP_LAYERS_CHANGED message.
        """
        index = self.layers.index(layer)
        if index > 0:
            del self.layers[index]
            self.layers.insert(index - 1, layer)
            self.changed(MAP_LAYERS_CHANGED, self)
            self.changed(MAP_STACKING_CHANGED, self)

    def BoundingBox(self):
        """Return the bounding box of the map in Lat/Lon coordinates.

        Return None if there are no layers or no layer contains any shapes.
        """
        if not self.layers:
            return None
        llx = []
        lly = []
        urx = []
        ury = []
        for layer in self.layers:
            if layer is self.label_layer:
                continue
            # the layer's bbox may be None if it doesn't have any layers
            bbox = layer.LatLongBoundingBox()
            if bbox is not None:
                left, bottom, right, top = bbox
                llx.append(left)
                lly.append(bottom)
                urx.append(right)
                ury.append(top)

        # check whether there were any empty layers.
        if llx:
            return (min(llx), min(lly), max(urx), max(ury))
        else:
            return None

    def ProjectedBoundingBox(self):
        """Return the bounding box of the map in projected coordinates.

        Return None if there are no layers or no layer contains any shapes.
        """
        # This simply returns the rectangle given by the projected
        # corners of the non-projected bbox.
        bbox = self.BoundingBox()
        if bbox is not None and self.projection is not None:
            bbox = self.projection.ForwardBBox(bbox)
        return bbox

    def SetProjection(self, projection):
        """Set the projection of the map.

        Issue a MAP_PROJECTION_CHANGED message."""
        self.projection = projection
        self.changed(MAP_PROJECTION_CHANGED, self)

    def forward(self, *args):
        """Reissue events"""
        if len(args) > 1:
            args = (args[-1],) + args[:-1]
        apply(self.issue, args)

    def WasModified(self):
        """Return true if the map or one of the layers was modified"""
        if self.modified:
            return 1
        else:
            for layer in self.layers:
                if layer.WasModified():
                    return 1
            return self.label_layer.WasModified()

    def UnsetModified(self):
        """Unset the modified flag of the map and the layers"""
        Modifiable.UnsetModified(self)
        for layer in self.layers:
            layer.UnsetModified()
        self.label_layer.UnsetModified()

    def TreeInfo(self):
        items = []
        if self.BoundingBox() != None:
            items.append(_("Extent (lat-lon): (%g, %g, %g, %g)")
                         % self.BoundingBox())
            if self.projection and len(self.projection.params) > 0:
                items.append(_("Extent (projected): (%g, %g, %g, %g)")
                             % self.ProjectedBoundingBox())
                items.append((_("Projection"),
                              [str(param)
                               for param in self.projection.params]))

        layers = self.layers[:]
        layers.reverse()
        items.extend(layers)

        return (_("Map: %s") % self.title, items)

1	# Copyright (c) 2001, 2002 by Intevation GmbH
2	# Authors:
3	# Bernhard Herzog <[email protected]>
4	#
5	# This program is free software under the GPL (>=v2)
6	# Read the file COPYING coming with Thuban for details.
7
8	__version__ = "$Revision$"
9
10	#from messages import MAP_LAYERS_CHANGED, MAP_PROJECTION_CHANGED, \
11	#CHANGED, LAYER_PROJECTION_CHANGED, LAYER_LEGEND_CHANGED, \
12	#LAYER_VISIBILITY_CHANGED
13
14	from messages import *
15
16	from Thuban import _
17
18	from base import TitledObject, Modifiable
19
20	from label import LabelLayer
21
22
23
24	class Map(TitledObject, Modifiable):
25
26	"""Represent a map. A map is simply a list of layers.
27
28	Map objects send the following message types:
29
30	TITLE_CHANGED -- The title has changed. Parameter: the map.
31
32	MAP_LAYERS_CHANGED -- Layers were added, removed or rearranged.
33	Parameters: the map
34
35	MAP_PROJECTION_CHANGED -- the map's projection has changed.
36	Parameter: the map
37	"""
38
39	forwarded_channels = (CHANGED,
40	LAYER_PROJECTION_CHANGED,
41	LAYER_LEGEND_CHANGED,
42	LAYER_CHANGED,
43	LAYER_VISIBILITY_CHANGED)
44
45	def __init__(self, title, projection = None):
46	"""Initialize the map."""
47	TitledObject.__init__(self, title)
48	Modifiable.__init__(self)
49	self.layers = []
50	self.label_layer = LabelLayer(_("Labels"))
51	self.label_layer.Subscribe(CHANGED, self.forward, MAP_LAYERS_CHANGED)
52	self.projection = projection
53
54	def Destroy(self):
55	# call Modifiable.Destroy first since it will call
56	# Publisher.Destroy which removes all subscriptions. Otherwise
57	# clearing the layers results in messages to be sent which can
58	# cause problems.
59	Modifiable.Destroy(self)
60	self.ClearLayers()
61	self.label_layer.Unsubscribe(CHANGED, self.forward, MAP_LAYERS_CHANGED)
62	self.label_layer.Destroy()
63
64	def AddLayer(self, layer):
65	"""Append layer to the map on top opf all."""
66	self.layers.append(layer)
67	self.subscribe_layer_channels(layer)
68	self.changed(MAP_LAYERS_CHANGED, self)
69	self.changed(MAP_LAYERS_ADDED, self)
70
71	def RemoveLayer(self, layer):
72	"""Remove layer from the map."""
73	self.unsubscribe_layer_channels(layer)
74	self.layers.remove(layer)
75	self.changed(MAP_LAYERS_CHANGED, self)
76	self.changed(MAP_LAYERS_REMOVED, self)
77	layer.Destroy()
78
79	def CanRemoveLayer(self, layer):
80	"""Return true if the layer can be deleted.
81
82	The default implementation always returns 1. Derived classes
83	should override this method if they have e.g. special layers
84	that the user should not be able to remove.
85	"""
86	return 1
87
88	def ClearLayers(self):
89	"""Delete all layers."""
90	for layer in self.layers:
91	self.unsubscribe_layer_channels(layer)
92	layer.Destroy()
93	del self.layers[:]
94	self.label_layer.ClearLabels()
95	self.changed(MAP_LAYERS_CHANGED, self)
96	self.changed(MAP_LAYERS_REMOVED, self)
97
98	def subscribe_layer_channels(self, layer):
99	"""Subscribe to some of layer's channels."""
100	for channel in self.forwarded_channels:
101	layer.Subscribe(channel, self.forward, channel)
102
103	def unsubscribe_layer_channels(self, layer):
104	"""Unsubscribe to some of layer's channels."""
105	for channel in self.forwarded_channels:
106	layer.Unsubscribe(channel, self.forward, channel)
107
108	def LabelLayer(self):
109	"""Return the Map's label layer"""
110	return self.label_layer
111
112	def Layers(self):
113	"""Return the list of layers contained in the map.
114
115	The list does not include the label layer"""
116	return self.layers
117
118	def HasLayers(self):
119	"""Return true if the map has at least one shape layer"""
120	return len(self.layers) > 0
121
122	def RaiseLayer(self, layer):
123	"""Swap the layer with the one above it.
124
125	If the layer is already at the top do nothing. If the stacking
126	order has been changed, issue a MAP_LAYERS_CHANGED message.
127	"""
128	index = self.layers.index(layer)
129	if index < len(self.layers) - 1:
130	del self.layers[index]
131	self.layers.insert(index + 1, layer)
132	self.changed(MAP_LAYERS_CHANGED, self)
133	self.changed(MAP_STACKING_CHANGED, self)
134
135	def LowerLayer(self, layer):
136	"""Swap the layer with the one below it.
137
138	If the layer is already at the bottom do nothing. If the
139	stacking order has been changed, issue a MAP_LAYERS_CHANGED message.
140	"""
141	index = self.layers.index(layer)
142	if index > 0:
143	del self.layers[index]
144	self.layers.insert(index - 1, layer)
145	self.changed(MAP_LAYERS_CHANGED, self)
146	self.changed(MAP_STACKING_CHANGED, self)
147
148	def BoundingBox(self):
149	"""Return the bounding box of the map in Lat/Lon coordinates.
150
151	Return None if there are no layers or no layer contains any shapes.
152	"""
153	if not self.layers:
154	return None
155	llx = []
156	lly = []
157	urx = []
158	ury = []
159	for layer in self.layers:
160	if layer is self.label_layer:
161	continue
162	# the layer's bbox may be None if it doesn't have any layers
163	bbox = layer.LatLongBoundingBox()
164	if bbox is not None:
165	left, bottom, right, top = bbox
166	llx.append(left)
167	lly.append(bottom)
168	urx.append(right)
169	ury.append(top)
170
171	# check whether there were any empty layers.
172	if llx:
173	return (min(llx), min(lly), max(urx), max(ury))
174	else:
175	return None
176
177	def ProjectedBoundingBox(self):
178	"""Return the bounding box of the map in projected coordinates.
179
180	Return None if there are no layers or no layer contains any shapes.
181	"""
182	# This simply returns the rectangle given by the projected
183	# corners of the non-projected bbox.
184	bbox = self.BoundingBox()
185	if bbox is not None and self.projection is not None:
186	bbox = self.projection.ForwardBBox(bbox)
187	return bbox
188
189	def SetProjection(self, projection):
190	"""Set the projection of the map.
191
192	Issue a MAP_PROJECTION_CHANGED message."""
193	self.projection = projection
194	self.changed(MAP_PROJECTION_CHANGED, self)
195
196	def forward(self, *args):
197	"""Reissue events"""
198	if len(args) > 1:
199	args = (args[-1],) + args[:-1]
200	apply(self.issue, args)
201
202	def WasModified(self):
203	"""Return true if the map or one of the layers was modified"""
204	if self.modified:
205	return 1
206	else:
207	for layer in self.layers:
208	if layer.WasModified():
209	return 1
210	return self.label_layer.WasModified()
211
212	def UnsetModified(self):
213	"""Unset the modified flag of the map and the layers"""
214	Modifiable.UnsetModified(self)
215	for layer in self.layers:
216	layer.UnsetModified()
217	self.label_layer.UnsetModified()
218
219	def TreeInfo(self):
220	items = []
221	if self.BoundingBox() != None:
222	items.append(_("Extent (lat-lon): (%g, %g, %g, %g)")
223	% self.BoundingBox())
224	if self.projection and len(self.projection.params) > 0:
225	items.append(_("Extent (projected): (%g, %g, %g, %g)")
226	% self.ProjectedBoundingBox())
227	items.append((_("Projection"),
228	[str(param)
229	for param in self.projection.params]))
230
231	layers = self.layers[:]
232	layers.reverse()
233	items.extend(layers)
234
235	return (_("Map: %s") % self.title, items)
236
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision