source: josm/trunk/src/org/openstreetmap/josm/data/ImageData.java@ 17459

Last change on this file since 17459 was 17459, checked in by Don-vip, 3 years ago

fix #20363 - Extract necessary method for QuadBuckets into separate interface (patch by taylor.smock, modified)
  • Property svn:eol-style set to native
File size: 10.6 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.data;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.util.ArrayList;
7import java.util.Collection;
8import java.util.Collections;
9import java.util.List;
10import java.util.stream.Collectors;
11
12import org.openstreetmap.josm.data.coor.LatLon;
13import org.openstreetmap.josm.data.gpx.GpxImageEntry;
14import org.openstreetmap.josm.data.osm.QuadBuckets;
15import org.openstreetmap.josm.gui.layer.geoimage.ImageEntry;
16import org.openstreetmap.josm.tools.ListenerList;
17
18/**
19 * Class to hold {@link ImageEntry} and the current selection
20 * @since 14590
21 */
22public class ImageData implements Data {
23 /**
24 * A listener that is informed when the current selection change
25 */
26 public interface ImageDataUpdateListener {
27 /**
28 * Called when the data change
29 * @param data the image data
30 */
31 void imageDataUpdated(ImageData data);
32
33 /**
34 * Called when the selection change
35 * @param data the image data
36 */
37 void selectedImageChanged(ImageData data);
38 }
39
40 private final List<ImageEntry> data;
41
42 private final List<Integer> selectedImagesIndex = new ArrayList<>();
43
44 private final ListenerList<ImageDataUpdateListener> listeners = ListenerList.create();
45 private final QuadBuckets<ImageEntry> geoImages = new QuadBuckets<>();
46
47 /**
48 * Construct a new image container without images
49 */
50 public ImageData() {
51 this(null);
52 }
53
54 /**
55 * Construct a new image container with a list of images
56 * @param data the list of {@link ImageEntry}
57 */
58 public ImageData(List<ImageEntry> data) {
59 if (data != null) {
60 Collections.sort(data);
61 this.data = data;
62 } else {
63 this.data = new ArrayList<>();
64 }
65 this.geoImages.addAll(data);
66 selectedImagesIndex.add(-1);
67 }
68
69 /**
70 * Returns the images
71 * @return the images
72 */
73 public List<ImageEntry> getImages() {
74 return data;
75 }
76
77 /**
78 * Determines if one image has modified GPS data.
79 * @return {@code true} if data has been modified; {@code false}, otherwise
80 */
81 public boolean isModified() {
82 return data.stream().anyMatch(GpxImageEntry::hasNewGpsData);
83 }
84
85 /**
86 * Merge 2 ImageData
87 * @param otherData {@link ImageData} to merge
88 */
89 public void mergeFrom(ImageData otherData) {
90 data.addAll(otherData.getImages());
91 this.geoImages.addAll(otherData.getImages());
92 Collections.sort(data);
93
94 final ImageEntry selected = otherData.getSelectedImage();
95
96 // Suppress the double photos.
97 if (data.size() > 1) {
98 ImageEntry prev = data.get(data.size() - 1);
99 for (int i = data.size() - 2; i >= 0; i--) {
100 ImageEntry cur = data.get(i);
101 if (cur.getFile().equals(prev.getFile())) {
102 data.remove(i);
103 } else {
104 prev = cur;
105 }
106 }
107 }
108 if (selected != null) {
109 setSelectedImageIndex(data.indexOf(selected));
110 }
111 }
112
113 /**
114 * Return the first currently selected image
115 * @return the first selected image as {@link ImageEntry} or null
116 * @see #getSelectedImages
117 */
118 public ImageEntry getSelectedImage() {
119 int selectedImageIndex = selectedImagesIndex.isEmpty() ? -1 : selectedImagesIndex.get(0);
120 if (selectedImageIndex > -1) {
121 return data.get(selectedImageIndex);
122 }
123 return null;
124 }
125
126 /**
127 * Return the current selected images
128 * @return the selected images as list {@link ImageEntry}
129 * @since 15333
130 */
131 public List<ImageEntry> getSelectedImages() {
132 return selectedImagesIndex.stream().filter(i -> i > -1).map(data::get).collect(Collectors.toList());
133 }
134
135 /**
136 * Select the first image of the sequence
137 */
138 public void selectFirstImage() {
139 if (!data.isEmpty()) {
140 setSelectedImageIndex(0);
141 }
142 }
143
144 /**
145 * Select the last image of the sequence
146 */
147 public void selectLastImage() {
148 setSelectedImageIndex(data.size() - 1);
149 }
150
151 /**
152 * Check if there is a next image in the sequence
153 * @return {@code true} is there is a next image, {@code false} otherwise
154 */
155 public boolean hasNextImage() {
156 return (selectedImagesIndex.size() == 1 && selectedImagesIndex.get(0) != data.size() - 1);
157 }
158
159 /**
160 * Search for images in a bounds
161 * @param bounds The bounds to search
162 * @return images in the bounds
163 * @since 17459
164 */
165 public Collection<ImageEntry> searchImages(Bounds bounds) {
166 return this.geoImages.search(bounds.toBBox());
167 }
168
169 /**
170 * Select the next image of the sequence
171 */
172 public void selectNextImage() {
173 if (hasNextImage()) {
174 setSelectedImageIndex(selectedImagesIndex.get(0) + 1);
175 }
176 }
177
178 /**
179 * Check if there is a previous image in the sequence
180 * @return {@code true} is there is a previous image, {@code false} otherwise
181 */
182 public boolean hasPreviousImage() {
183 return (selectedImagesIndex.size() == 1 && selectedImagesIndex.get(0) - 1 > -1);
184 }
185
186 /**
187 * Select the previous image of the sequence
188 */
189 public void selectPreviousImage() {
190 if (data.isEmpty()) {
191 return;
192 }
193 setSelectedImageIndex(Integer.max(0, selectedImagesIndex.get(0) - 1));
194 }
195
196 /**
197 * Select as the selected the given image
198 * @param image the selected image
199 */
200 public void setSelectedImage(ImageEntry image) {
201 setSelectedImageIndex(data.indexOf(image));
202 }
203
204 /**
205 * Add image to the list of selected images
206 * @param image {@link ImageEntry} the image to add
207 * @since 15333
208 */
209 public void addImageToSelection(ImageEntry image) {
210 int index = data.indexOf(image);
211 if (selectedImagesIndex.get(0) == -1) {
212 setSelectedImage(image);
213 } else if (!selectedImagesIndex.contains(index)) {
214 selectedImagesIndex.add(index);
215 listeners.fireEvent(l -> l.selectedImageChanged(this));
216 }
217 }
218
219 /**
220 * Remove the image from the list of selected images
221 * @param image {@link ImageEntry} the image to remove
222 * @since 15333
223 */
224 public void removeImageToSelection(ImageEntry image) {
225 int index = data.indexOf(image);
226 selectedImagesIndex.remove(selectedImagesIndex.indexOf(index));
227 if (selectedImagesIndex.isEmpty()) {
228 selectedImagesIndex.add(-1);
229 }
230 listeners.fireEvent(l -> l.selectedImageChanged(this));
231 }
232
233 /**
234 * Clear the selected image(s)
235 */
236 public void clearSelectedImage() {
237 setSelectedImageIndex(-1);
238 }
239
240 private void setSelectedImageIndex(int index) {
241 setSelectedImageIndex(index, false);
242 }
243
244 private void setSelectedImageIndex(int index, boolean forceTrigger) {
245 if (selectedImagesIndex.size() > 1) {
246 selectedImagesIndex.clear();
247 selectedImagesIndex.add(-1);
248 }
249 if (index == selectedImagesIndex.get(0) && !forceTrigger) {
250 return;
251 }
252 selectedImagesIndex.set(0, index);
253 listeners.fireEvent(l -> l.selectedImageChanged(this));
254 }
255
256 /**
257 * Remove the current selected image from the list
258 */
259 public void removeSelectedImage() {
260 List<ImageEntry> selectedImages = getSelectedImages();
261 if (selectedImages.size() > 1) {
262 throw new IllegalStateException(tr("Multiple images have been selected"));
263 }
264 removeImages(selectedImages);
265 }
266
267 /**
268 * Remove the current selected image from the list
269 * @since 15348
270 */
271 public void removeSelectedImages() {
272 List<ImageEntry> selectedImages = getSelectedImages();
273 removeImages(selectedImages);
274 }
275
276 private void removeImages(List<ImageEntry> selectedImages) {
277 if (selectedImages.isEmpty()) {
278 return;
279 }
280 for (ImageEntry img: getSelectedImages()) {
281 data.remove(img);
282 this.geoImages.remove(img);
283 }
284 if (selectedImagesIndex.get(0) >= data.size()) {
285 setSelectedImageIndex(data.size() - 1);
286 } else {
287 setSelectedImageIndex(selectedImagesIndex.get(0), true);
288 }
289 }
290
291 /**
292 * Determines if the image is selected
293 * @param image the {@link ImageEntry} image
294 * @return {@code true} is the image is selected, {@code false} otherwise
295 * @since 15333
296 */
297 public boolean isImageSelected(ImageEntry image) {
298 int index = data.indexOf(image);
299 return selectedImagesIndex.contains(index);
300 }
301
302 /**
303 * Remove the image from the list and trigger update listener
304 * @param img the {@link ImageEntry} to remove
305 */
306 public void removeImage(ImageEntry img) {
307 data.remove(img);
308 this.geoImages.remove(img);
309 notifyImageUpdate();
310 }
311
312 /**
313 * Update the position of the image and trigger update
314 * @param img the image to update
315 * @param newPos the new position
316 */
317 public void updateImagePosition(ImageEntry img, LatLon newPos) {
318 img.setPos(newPos);
319 this.geoImages.remove(img);
320 this.geoImages.add(img);
321 afterImageUpdated(img);
322 }
323
324 /**
325 * Update the image direction of the image and trigger update
326 * @param img the image to update
327 * @param direction the new direction
328 */
329 public void updateImageDirection(ImageEntry img, double direction) {
330 img.setExifImgDir(direction);
331 afterImageUpdated(img);
332 }
333
334 /**
335 * Manually trigger the {@link ImageDataUpdateListener#imageDataUpdated(ImageData)}
336 */
337 public void notifyImageUpdate() {
338 listeners.fireEvent(l -> l.imageDataUpdated(this));
339 }
340
341 private void afterImageUpdated(ImageEntry img) {
342 img.flagNewGpsData();
343 notifyImageUpdate();
344 }
345
346 /**
347 * Add a listener that listens to image data changes
348 * @param listener the {@link ImageDataUpdateListener}
349 */
350 public void addImageDataUpdateListener(ImageDataUpdateListener listener) {
351 listeners.addListener(listener);
352 }
353
354 /**
355 * Removes a listener that listens to image data changes
356 * @param listener The listener
357 */
358 public void removeImageDataUpdateListener(ImageDataUpdateListener listener) {
359 listeners.removeListener(listener);
360 }
361
362 @Override
363 public Collection<DataSource> getDataSources() {
364 return Collections.emptyList();
365 }
366}
Note: See TracBrowser for help on using the repository browser.