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;
27  
28  import jakarta.annotation.Nonnull;
29  import org.apiguardian.api.API;
30  import lombok.EqualsAndHashCode;
31  import lombok.Getter;
32  import lombok.RequiredArgsConstructor;
33  import lombok.experimental.Accessors;
34  import static org.apiguardian.api.API.Status.STABLE;
35  
36  /***************************************************************************************************************************************************************
37   *
38   * This class represents a point on the map representing the world. (0, 0) corresponds to the crossing between the equator and the Greenwich meridian.
39   *
40   * @see     MapCoordinates
41   * @see     MapViewPoint
42   * @author  Fabrizio Giudici
43   *
44   **************************************************************************************************************************************************************/
45  @API(status = STABLE)
46  @RequiredArgsConstructor(staticName = "of") @Accessors(fluent = true) @Getter @EqualsAndHashCode
47  public final class MapPoint implements Cartesian
48    {
49      private final double x;
50  
51      private final double y;
52  
53      /***********************************************************************************************************************************************************
54       * {@return a point translated of the specified amount}.
55       * @param   dx    the horizontal translation
56       * @param   dy    the vertical translation
57       **********************************************************************************************************************************************************/
58      @Nonnull
59      public MapPoint translated (final double dx, final double dy)
60        {
61          return new MapPoint(x + dx, y + dy);
62        }
63  
64      /***********************************************************************************************************************************************************
65       * {@inheritDoc}
66       **********************************************************************************************************************************************************/
67      @Override @Nonnull
68      public String toString()
69        {
70          return String.format("MapPoint(%f, %f)", x, y);
71        }
72    }