001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/graphics/displayelements/GeometryDisplayElement.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53115 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042
043 ---------------------------------------------------------------------------*/
044 package org.deegree.graphics.displayelements;
045
046 import java.io.Serializable;
047
048 import org.deegree.graphics.sld.Symbolizer;
049 import org.deegree.model.feature.Feature;
050 import org.deegree.model.spatialschema.Envelope;
051 import org.deegree.model.spatialschema.Geometry;
052 import org.deegree.model.spatialschema.Position;
053
054 /**
055 * Basic interface of all display elements that are related to a geometry (this is the common case).
056 *
057 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
058 * @author last edited by: $Author: apoth $
059 *
060 * @version $Revision: 9340 $, $Date: 2007-12-27 13:32:12 +0100 (Do, 27 Dez 2007) $
061 */
062 abstract class GeometryDisplayElement extends AbstractDisplayElement implements Serializable {
063
064 /** Use serialVersionUID for interoperability. */
065 private final static long serialVersionUID = 465725117946501686L;
066
067 protected Geometry geometry;
068
069 protected Symbolizer symbolizer;
070
071 protected Symbolizer highlightSymbolizer;
072
073 protected Symbolizer selectedSymbolizer;
074
075 protected Object placement;
076
077 /**
078 * Creates a new GeometryDisplayElement object.
079 *
080 * @param feature
081 * @param geometry
082 */
083 GeometryDisplayElement( Feature feature, Geometry geometry ) {
084 super( feature );
085 setGeometry( geometry );
086 }
087
088 /**
089 * Creates a new GeometryDisplayElement object.
090 *
091 * @param feature
092 * @param geometry
093 * @param symbolizer
094 */
095 GeometryDisplayElement( Feature feature, Geometry geometry, Symbolizer symbolizer ) {
096 super( feature );
097 setGeometry( geometry );
098 setSymbolizer( symbolizer );
099 setHighlightSymbolizer( symbolizer );
100 setSelectedSymbolizer( symbolizer );
101 }
102
103 /**
104 * Creates a new GeometryDisplayElement object.
105 *
106 * @param feature
107 * @param geometry
108 * @param symbolizer
109 * @param selectedSymbolizer
110 * @param highlightSymbolizer
111 */
112 GeometryDisplayElement( Feature feature, Geometry geometry, Symbolizer symbolizer,
113 Symbolizer highlightSymbolizer, Symbolizer selectedSymbolizer ) {
114 super( feature );
115 setGeometry( geometry );
116 setSymbolizer( symbolizer );
117 setSelectedSymbolizer( selectedSymbolizer );
118 setHighlightSymbolizer( highlightSymbolizer );
119 }
120
121 /**
122 * Returns a new {@link Envelope} for the given envelope that has a border of percent * (with |
123 * height) on all sides around it (the longer side is used to determine the border size).
124 *
125 * @param env
126 * @param percent
127 * @return envelope with border around it
128 */
129 protected Envelope growEnvelope( Envelope env, float percent ) {
130 Position minPos = env.getMin();
131 Position maxPos = env.getMax();
132 double h = maxPos.getX() - minPos.getX();
133 double w = maxPos.getY() - minPos.getY();
134 h = Math.abs( h );
135 w = Math.abs( w );
136 double maxSide = Math.max( w, h );
137 return env.getBuffer( maxSide * percent );
138 }
139
140 /**
141 * Overwrites the default placement of the <tt>DisplayElement</tt>. This method is used by
142 * the <tt>PlacementOptimizer</tt> to minimize the overlapping of labels, for example.
143 * <p>
144 *
145 * @param o
146 * the placement to be used
147 */
148 public void setPlacement( Object o ) {
149 placement = o;
150 }
151
152 /**
153 * sets the geometry that determines the position the DisplayElement will be rendered to
154 */
155 public void setGeometry( Geometry geometry ) {
156 this.geometry = geometry;
157 }
158
159 /**
160 * returns the geometry that determines the position the DisplayElement will be rendered to
161 */
162 public Geometry getGeometry() {
163 return geometry;
164 }
165
166 /**
167 * sets the rules that determines how the geometry will be rendered
168 */
169 public void setSymbolizer( Symbolizer symbolizer ) {
170 this.symbolizer = symbolizer;
171 }
172
173 /**
174 * Returns the symbolizer that determines how the geometry will be rendered.
175 */
176 public Symbolizer getSymbolizer() {
177 return symbolizer;
178 }
179
180 /**
181 * sets the rule that determines how the geometry will be rendered when it's highlighted
182 *
183 * @param rule
184 * symbolizer defining rendering style
185 */
186 public void setHighlightSymbolizer( Symbolizer rule ) {
187 this.highlightSymbolizer = rule;
188 }
189
190 /**
191 * returns the symbolizer that determines how the geometry will be rendered if it's highlighted
192 */
193 public Symbolizer getHighlightSymbolizer() {
194 return highlightSymbolizer;
195 }
196
197 /**
198 * sets the rule that determines how the geometry will be rendered when it's selected
199 *
200 * @param rule
201 * symbolizer defining rendering style
202 */
203 public void setSelectedSymbolizer( Symbolizer rule ) {
204 selectedSymbolizer = rule;
205 }
206
207 /**
208 * returns the symbolizer that determines how the geometry will be rendered if it's selected
209 */
210 public Symbolizer getSelectedSymbolizer() {
211 return selectedSymbolizer;
212 }
213
214 /**
215 * Returns if the <tt>DisplayElement</tt> should be painted at the current scale or not.
216 */
217 public boolean doesScaleConstraintApply( double scale ) {
218 return symbolizer.getMinScaleDenominator() <= scale
219 && symbolizer.getMaxScaleDenominator() > scale;
220 }
221 }