aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/service/protocol/WhiteboardPoint.java
blob: 3e26e7a4b5c898cafc69c7ecaa73476ddc83893d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.service.protocol;

import java.util.Objects;

/**
 * A point representing a location in {@code (x,y)} coordinate space,
 * specified in integer precision.
 * <p>
 * This class has been inspired by the java.awt.Point class.
 * <p>
 * @author Julien Waechter
 * @author Emil Ivov
 */
public class WhiteboardPoint implements Cloneable
{
    /**
     * The X coordinate of this WhiteboadPoint.
     */
    private double x;

    /**
     * The Y coordinate of this <code>Point</code>.
     */
    private double y;

    /**
     * Constructs and initializes a point with the same location as
     * the specified <tt>Point</tt> object.
     * @param p a point
     */
    public WhiteboardPoint(WhiteboardPoint p)
    {
        this(p.x, p.y);
    }

    /**
     * Constructs and initializes a point at the specified <tt>(x,y)</tt>
     * location in the coordinate space.
     *
     * @param x the X coordinate of the newly constructed <code>Point</code>
     * @param y the Y coordinate of the newly constructed <code>Point</code>
     * @since 1.0
     */
    public WhiteboardPoint(double x, double y)
    {
        this.x = x;
        this.y = y;
    }

    /**
     * Returns the X coordinate of this <tt>WhiteboardPoint</tt>.
     *
     * @return the x coordinate of this <tt>WhiteboardPoint</tt>.
     */
    public double getX()
    {
        return x;
    }

    /**
     * Returns the Y coordinate of this <tt>WhiteboardPoint</tt>.
     *
     * @return the y coordinate of this <tt>WhiteboardPoint</tt>.
     */
    public double getY()
    {
        return y;
    }

    /**
     * Sets a new value to the x coordinate.
     *
     * @param x the new value of the x coordinate
     */
    public void setX(double x)
    {
        this.x = x;
    }

    /**
     * Sets a new value to the y coordinate.
     *
     * @param y the new value of the y coordinate
     */
    public void setY(double y)
    {
        this.y = y;
    }

    /**
     * Determines whether or not two points are equal. Two instances of
     * <tt>WhiteboardPoint</tt> are equal if the values of their
     * <tt>x</tt> and <tt>y</tt> member fields, representing
     * their position in the coordinate space, are the same.
     *
     * @param obj an object to be compared with this <tt>WhiteboardPoint</tt>
     *
     * @return <tt>true</tt> if the object to be compared is an instance of
     * <tt>WhiteboardPoint</tt> and has the same values; <tt>false</tt>
     * otherwise.
     */
    @Override
    public boolean equals(Object obj)
    {
        if (obj instanceof WhiteboardPoint)
        {
            WhiteboardPoint pt = (WhiteboardPoint)obj;
            return (x == pt.x) && (y == pt.y);
        }

        return false;
    }

    @Override
    public int hashCode()
    {
        return Objects.hash(x, y);
    }

    /**
     * Returns a string representation of this point and its location
     * in the {@code (x,y)} coordinate space. This method is intended to be
     * used only for debugging purposes, and the content  and format of the
     * returned string may vary between implementations.
     *
     * The returned string may be empty but may not be <code>null</code>.
     *
     * @return a string representation of this point
     */
    @Override
    public String toString()
    {
        return getClass().getName() + "[x=" + x + ",y=" + y + "]";
    }

    /**
     * Creates and returns a copy of this <tt>WhiteboardPoint</tt>.
     *
     * @return     a clone of this <tt>WhiteboardPoint</tt> instance.
     */
    @Override
    protected Object clone()
    {
        return new WhiteboardPoint(this);
    }

    /**
     * Calculates the distance from this point the given point.
     *
     * @param p the point to which to calculate the distance
     * @return the distance between this point and the given point
     */
    public double distance(WhiteboardPoint p)
    {
        double PX = p.getX() - this.getX();
        double PY = p.getY() - this.getY();

        return Math.sqrt(PX * PX + PY * PY);
    }
}