source: josm/trunk/src/org/openstreetmap/josm/gui/layer/ImageryLayer.java@ 12340

Last change on this file since 12340 was 12093, checked in by bastiK, 7 years ago

fixed #14734 - Handling imagery offsets when reprojecting
  • Property svn:eol-style set to native
File size: 10.9 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.layer;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trc;
6
7import java.awt.Component;
8import java.awt.GridBagLayout;
9import java.awt.event.ActionEvent;
10import java.awt.image.BufferedImage;
11import java.awt.image.BufferedImageOp;
12import java.util.ArrayList;
13import java.util.Arrays;
14import java.util.List;
15import java.util.Locale;
16
17import javax.swing.AbstractAction;
18import javax.swing.Action;
19import javax.swing.BorderFactory;
20import javax.swing.Icon;
21import javax.swing.JCheckBoxMenuItem;
22import javax.swing.JComponent;
23import javax.swing.JLabel;
24import javax.swing.JMenu;
25import javax.swing.JMenuItem;
26import javax.swing.JPanel;
27import javax.swing.JPopupMenu;
28import javax.swing.JSeparator;
29import javax.swing.JTextField;
30
31import org.openstreetmap.josm.Main;
32import org.openstreetmap.josm.data.ProjectionBounds;
33import org.openstreetmap.josm.data.coor.EastNorth;
34import org.openstreetmap.josm.data.imagery.ImageryInfo;
35import org.openstreetmap.josm.data.imagery.OffsetBookmark;
36import org.openstreetmap.josm.data.preferences.IntegerProperty;
37import org.openstreetmap.josm.gui.MenuScroller;
38import org.openstreetmap.josm.gui.layer.imagery.ImageryFilterSettings;
39import org.openstreetmap.josm.gui.layer.imagery.TileSourceDisplaySettings;
40import org.openstreetmap.josm.tools.GBC;
41import org.openstreetmap.josm.tools.ImageProvider;
42import org.openstreetmap.josm.tools.ImageProvider.ImageSizes;
43import org.openstreetmap.josm.tools.Utils;
44
45public abstract class ImageryLayer extends Layer {
46
47 public static final IntegerProperty PROP_SHARPEN_LEVEL = new IntegerProperty("imagery.sharpen_level", 0);
48
49 private final List<ImageProcessor> imageProcessors = new ArrayList<>();
50
51 protected final ImageryInfo info;
52
53 protected Icon icon;
54
55 private final ImageryFilterSettings filterSettings = new ImageryFilterSettings();
56
57 /**
58 * Constructs a new {@code ImageryLayer}.
59 * @param info imagery info
60 */
61 public ImageryLayer(ImageryInfo info) {
62 super(info.getName());
63 this.info = info;
64 if (info.getIcon() != null) {
65 icon = new ImageProvider(info.getIcon()).setOptional(true).
66 setMaxSize(ImageSizes.LAYER).get();
67 }
68 if (icon == null) {
69 icon = ImageProvider.get("imagery_small");
70 }
71 for (ImageProcessor processor : filterSettings.getProcessors()) {
72 addImageProcessor(processor);
73 }
74 filterSettings.setSharpenLevel(1 + PROP_SHARPEN_LEVEL.get() / 2f);
75 }
76
77 public double getPPD() {
78 if (!Main.isDisplayingMapView())
79 return Main.getProjection().getDefaultZoomInPPD();
80 ProjectionBounds bounds = Main.map.mapView.getProjectionBounds();
81 return Main.map.mapView.getWidth() / (bounds.maxEast - bounds.minEast);
82 }
83
84 /**
85 * Gets the x displacement of this layer.
86 * To be removed end of 2016
87 * @return The x displacement.
88 * @deprecated Use {@link TileSourceDisplaySettings#getDx()}
89 */
90 @Deprecated
91 public double getDx() {
92 // moved to AbstractTileSourceLayer/TileSourceDisplaySettings. Remains until all actions migrate.
93 return 0;
94 }
95
96 /**
97 * Gets the y displacement of this layer.
98 * To be removed end of 2016
99 * @return The y displacement.
100 * @deprecated Use {@link TileSourceDisplaySettings#getDy()}
101 */
102 @Deprecated
103 public double getDy() {
104 // moved to AbstractTileSourceLayer/TileSourceDisplaySettings. Remains until all actions migrate.
105 return 0;
106 }
107
108 /**
109 * Sets the displacement offset of this layer. The layer is automatically invalidated.
110 * To be removed end of 2016
111 * @param offset the offset bookmark
112 * @deprecated Use {@link TileSourceDisplaySettings}
113 */
114 @Deprecated
115 public void setOffset(OffsetBookmark offset) {
116 // moved to AbstractTileSourceLayer/TileSourceDisplaySettings. Remains until all actions migrate.
117 }
118
119 /**
120 * Returns imagery info.
121 * @return imagery info
122 */
123 public ImageryInfo getInfo() {
124 return info;
125 }
126
127 @Override
128 public Icon getIcon() {
129 return icon;
130 }
131
132 @Override
133 public boolean isMergable(Layer other) {
134 return false;
135 }
136
137 @Override
138 public void mergeFrom(Layer from) {
139 }
140
141 @Override
142 public Object getInfoComponent() {
143 JPanel panel = new JPanel(new GridBagLayout());
144 panel.add(new JLabel(getToolTipText()), GBC.eol());
145 if (info != null) {
146 List<List<String>> content = new ArrayList<>();
147 content.add(Arrays.asList(tr("Name"), info.getName()));
148 content.add(Arrays.asList(tr("Type"), info.getImageryType().getTypeString().toUpperCase(Locale.ENGLISH)));
149 content.add(Arrays.asList(tr("URL"), info.getUrl()));
150 content.add(Arrays.asList(tr("Id"), info.getId() == null ? "-" : info.getId()));
151 if (info.getMinZoom() != 0) {
152 content.add(Arrays.asList(tr("Min. zoom"), Integer.toString(info.getMinZoom())));
153 }
154 if (info.getMaxZoom() != 0) {
155 content.add(Arrays.asList(tr("Max. zoom"), Integer.toString(info.getMaxZoom())));
156 }
157 if (info.getDescription() != null) {
158 content.add(Arrays.asList(tr("Description"), info.getDescription()));
159 }
160 for (List<String> entry: content) {
161 panel.add(new JLabel(entry.get(0) + ':'), GBC.std());
162 panel.add(GBC.glue(5, 0), GBC.std());
163 panel.add(createTextField(entry.get(1)), GBC.eol().fill(GBC.HORIZONTAL));
164 }
165 }
166 return panel;
167 }
168
169 protected JTextField createTextField(String text) {
170 JTextField ret = new JTextField(text);
171 ret.setEditable(false);
172 ret.setBorder(BorderFactory.createEmptyBorder());
173 return ret;
174 }
175
176 public static ImageryLayer create(ImageryInfo info) {
177 switch(info.getImageryType()) {
178 case WMS:
179 return new WMSLayer(info);
180 case WMTS:
181 return new WMTSLayer(info);
182 case TMS:
183 case BING:
184 case SCANEX:
185 return new TMSLayer(info);
186 default:
187 throw new AssertionError(tr("Unsupported imagery type: {0}", info.getImageryType()));
188 }
189 }
190
191 class ApplyOffsetAction extends AbstractAction {
192 private final transient OffsetBookmark b;
193
194 ApplyOffsetAction(OffsetBookmark b) {
195 super(b.getName());
196 this.b = b;
197 }
198
199 @Override
200 public void actionPerformed(ActionEvent ev) {
201 setOffset(b);
202 Main.main.menu.imageryMenu.refreshOffsetMenu();
203 Main.map.repaint();
204 }
205 }
206
207 public class OffsetAction extends AbstractAction implements LayerAction {
208 @Override
209 public void actionPerformed(ActionEvent e) {
210 // Do nothing
211 }
212
213 @Override
214 public Component createMenuComponent() {
215 return getOffsetMenuItem();
216 }
217
218 @Override
219 public boolean supportLayers(List<Layer> layers) {
220 return false;
221 }
222 }
223
224 public JMenuItem getOffsetMenuItem() {
225 JMenu subMenu = new JMenu(trc("layer", "Offset"));
226 subMenu.setIcon(ImageProvider.get("mapmode", "adjustimg"));
227 return (JMenuItem) getOffsetMenuItem(subMenu);
228 }
229
230 public JComponent getOffsetMenuItem(JComponent subMenu) {
231 JMenuItem adjustMenuItem = new JMenuItem(getAdjustAction());
232 List<OffsetBookmark> allBookmarks = OffsetBookmark.getBookmarks();
233 if (allBookmarks.isEmpty()) return adjustMenuItem;
234
235 subMenu.add(adjustMenuItem);
236 subMenu.add(new JSeparator());
237 boolean hasBookmarks = false;
238 int menuItemHeight = 0;
239 for (OffsetBookmark b : allBookmarks) {
240 if (!b.isUsable(this)) {
241 continue;
242 }
243 JCheckBoxMenuItem item = new JCheckBoxMenuItem(new ApplyOffsetAction(b));
244 EastNorth offset = b.getDisplacement(Main.getProjection());
245 if (Utils.equalsEpsilon(offset.east(), getDx()) && Utils.equalsEpsilon(offset.north(), getDy())) {
246 item.setSelected(true);
247 }
248 subMenu.add(item);
249 menuItemHeight = item.getPreferredSize().height;
250 hasBookmarks = true;
251 }
252 if (menuItemHeight > 0) {
253 if (subMenu instanceof JMenu) {
254 MenuScroller.setScrollerFor((JMenu) subMenu);
255 } else if (subMenu instanceof JPopupMenu) {
256 MenuScroller.setScrollerFor((JPopupMenu) subMenu);
257 }
258 }
259 return hasBookmarks ? subMenu : adjustMenuItem;
260 }
261
262 protected abstract Action getAdjustAction();
263
264 /**
265 * Gets the settings for the filter that is applied to this layer.
266 * @return The filter settings.
267 * @since 10547
268 */
269 public ImageryFilterSettings getFilterSettings() {
270 return filterSettings;
271 }
272
273 /**
274 * This method adds the {@link ImageProcessor} to this Layer if it is not {@code null}.
275 *
276 * @param processor that processes the image
277 *
278 * @return true if processor was added, false otherwise
279 */
280 public boolean addImageProcessor(ImageProcessor processor) {
281 return processor != null && imageProcessors.add(processor);
282 }
283
284 /**
285 * This method removes given {@link ImageProcessor} from this layer
286 *
287 * @param processor which is needed to be removed
288 *
289 * @return true if processor was removed
290 */
291 public boolean removeImageProcessor(ImageProcessor processor) {
292 return imageProcessors.remove(processor);
293 }
294
295 /**
296 * Wraps a {@link BufferedImageOp} to be used as {@link ImageProcessor}.
297 * @param op the {@link BufferedImageOp}
298 * @param inPlace true to apply filter in place, i.e., not create a new {@link BufferedImage} for the result
299 * (the {@code op} needs to support this!)
300 * @return the {@link ImageProcessor} wrapper
301 */
302 public static ImageProcessor createImageProcessor(final BufferedImageOp op, final boolean inPlace) {
303 return image -> op.filter(image, inPlace ? image : null);
304 }
305
306 /**
307 * This method gets all {@link ImageProcessor}s of the layer
308 *
309 * @return list of image processors without removed one
310 */
311 public List<ImageProcessor> getImageProcessors() {
312 return imageProcessors;
313 }
314
315 /**
316 * Applies all the chosen {@link ImageProcessor}s to the image
317 *
318 * @param img - image which should be changed
319 *
320 * @return the new changed image
321 */
322 public BufferedImage applyImageProcessors(BufferedImage img) {
323 for (ImageProcessor processor : imageProcessors) {
324 img = processor.process(img);
325 }
326 return img;
327 }
328
329 @Override
330 public String toString() {
331 return getClass().getSimpleName() + " [info=" + info + ']';
332 }
333}
Note: See TracBrowser for help on using the repository browser.