View Javadoc
1   /*
2    * *************************************************************************************************************************************************************
3    *
4    * MapView: a JavaFX map renderer for tile-based servers
5    * http://tidalwave.it/projects/mapview
6    *
7    * Copyright (C) 2024 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
8    *
9    * *************************************************************************************************************************************************************
10   *
11   * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12   * You may obtain a copy of the License at
13   *
14   *     http://www.apache.org/licenses/LICENSE-2.0
15   *
16   * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17   * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
18   *
19   * *************************************************************************************************************************************************************
20   *
21   * git clone https://bitbucket.org/tidalwave/mapview-src
22   * git clone https://github.com/tidalwave-it/mapview-src
23   *
24   * *************************************************************************************************************************************************************
25   */
26  package it.tidalwave.mapviewer.javafx.impl;
27  
28  import jakarta.annotation.Nonnull;
29  import java.net.URI;
30  import javafx.scene.image.ImageView;
31  import it.tidalwave.mapviewer.TileSource;
32  import lombok.Getter;
33  
34  /***************************************************************************************************************************************************************
35   *
36   * This class represents a single tile for rendering a map. It basically wraps a bitmap that is available on the internet at a specific URL, and it has the
37   * capability of being loaded in background and rendering some temporary icons while the process has not terminated.
38   * 
39   * @author  Fabrizio Giudici
40   *
41   **************************************************************************************************************************************************************/
42  @Getter
43  public class Tile extends ImageView
44    {
45      /** The source of tile bitmaps. */
46      @Nonnull
47      private final TileSource source;
48  
49      /** The URL of this tile. */
50      private final URI uri;
51  
52      /** The zoom level this tile belongs to. */
53      private final int zoom;
54  
55      /***********************************************************************************************************************************************************
56       * Creates a new tile and submits it to the cache for downloading.
57       * @param   tileCache       the tile cache
58       * @param   source          the tile source
59       * @param   uri             the URL of the tile
60       * @param   size            the size of the tile
61       * @param   zoom            the zoom level of this tile
62       **********************************************************************************************************************************************************/
63      @SuppressWarnings("this-escape")
64      protected Tile (@Nonnull final TileCache tileCache, @Nonnull final TileSource source, @Nonnull final URI uri, final int size, final int zoom)
65        {
66          this.source = source;
67          this.uri = uri;
68          this.zoom = zoom;
69          setFitWidth(size);
70          setFitHeight(size);
71          tileCache.loadTileInBackground(this);
72        }
73    }