Module org.arakhne.afc.core.mathgeom

Package org.arakhne.afc.math.geometry.d2

Class ImmutablePoint2D

java.lang.Object

org.arakhne.afc.math.geometry.d2.ImmutablePoint2D

All Implemented Interfaces:

Serializable, Cloneable, Point2D<ImmutablePoint2D,ImmutableVector2D>, Tuple2D<ImmutablePoint2D>, UnmodifiablePoint2D<ImmutablePoint2D,ImmutableVector2D>, UnmodifiableTuple2D<ImmutablePoint2D>, JsonableObject

public final class ImmutablePoint2D
extends Object
implements UnmodifiablePoint2D<ImmutablePoint2D,ImmutableVector2D>

Immutable point 2D.

Since:

13.0

Version:

17.0 2020-01-04 14:41:43

Author:

Stéphane GALLAND

See Also:

Serialized Form

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathgeom

Constructor Summary

Constructors

Constructor	Description
ImmutablePoint2D(double x, double y)	Constructor.
ImmutablePoint2D(int x, int y)	Constructor.

Method Summary

Modifier and Type	Method	Description
ImmutablePoint2D	clone()	Clone this point.
boolean	equals(Object object)	Returns true if the Object t1 is of type Tuple2D and all of the data members of t1 are equal to the corresponding data members in this Tuple2D.
ImmutableGeomFactory	getGeomFactory()	Replies the geometry factory associated to this point.
double	getX()	Get the x coordinate.
double	getY()	Get the y coordinate.
int	hashCode()	Returns a hash code value based on the data values in this object.
int	ix()	Get the x coordinate.
int	iy()	Get the y coordinate.
void	toJson(JsonBuffer buffer)	Replies the Json representation of this node.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.arakhne.afc.math.geometry.d2.Point2D

$amp$amp, $minus, $minus, $minus, $plus, $plus, getDistance, getDistanceL1, getDistanceLinf, getDistanceSquared, getIdistanceL1, getIdistanceLinf, operator_and, operator_elvis, operator_equals, operator_minus, operator_minus, operator_minus, operator_notEquals, operator_plus, operator_plus, operator_upTo, operator_upTo

Methods inherited from interface org.arakhne.afc.math.geometry.d2.Tuple2D

epsilonEquals, equals, get, get, get

Methods inherited from interface org.arakhne.afc.math.geometry.d2.UnmodifiablePoint2D

add, add, add, operator_add, operator_remove, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleAdd, scaleAdd, sub, sub, toUnmodifiable, turn, turn, turn, turnLeft, turnLeft, turnLeft, turnRight, turnRight, turnRight

Methods inherited from interface org.arakhne.afc.math.geometry.d2.UnmodifiableTuple2D

absolute, absolute, add, add, addX, addX, addY, addY, clamp, clamp, clamp, clamp, clampMax, clampMax, clampMax, clampMax, clampMin, clampMin, clampMin, clampMin, interpolate, interpolate, negate, negate, scale, scale, scale, scale, set, set, set, set, set, setX, setX, setY, setY, sub, sub, subX, subX, subY, subY

Constructor Detail

ImmutablePoint2D

public ImmutablePoint2D(double x,
                        double y)

Constructor.

Parameters:

x - x coordinate.

y - y coordinate.

ImmutablePoint2D

public ImmutablePoint2D(int x,
                        int y)

Constructor.

Parameters:

x - x coordinate.

y - y coordinate.

Method Detail

getGeomFactory

public ImmutableGeomFactory getGeomFactory()

Description copied from interface: Point2D

Replies the geometry factory associated to this point.

Specified by:

getGeomFactory in interface Point2D<ImmutablePoint2D,ImmutableVector2D>

Returns:

the factory.

equals

@Pure
public boolean equals(Object object)

Description copied from interface: Tuple2D

Returns true if the Object t1 is of type Tuple2D and all of the data members of t1 are equal to the corresponding data members in this Tuple2D.

Specified by:

equals in interface Tuple2D<ImmutablePoint2D>

Overrides:

equals in class Object

Parameters:

object - the object with which the comparison is made

Returns:

true or false

hashCode

@Pure
public int hashCode()

Description copied from interface: Tuple2D

Returns a hash code value based on the data values in this object. Two different Tuple2D objects with identical data values (i.e., Tuple2D.equals(Object) returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely.

Specified by:

hashCode in interface Tuple2D<ImmutablePoint2D>

Overrides:

hashCode in class Object

Returns:

the integer hash code value

toString

@Pure
public String toString()

Overrides:

toString in class Object

toJson

public void toJson(JsonBuffer buffer)

Description copied from interface: JsonableObject

Replies the Json representation of this node.

Specified by:

toJson in interface JsonableObject

Parameters:

buffer - the Json buffer.

clone

@Pure
public ImmutablePoint2D clone()

Description copied from interface: Tuple2D

Clone this point.

Specified by:

clone in interface Tuple2D<ImmutablePoint2D>

Overrides:

clone in class Object

Returns:

the clone.

getX

@Pure
public double getX()

Description copied from interface: Tuple2D

Get the x coordinate.

Specified by:

getX in interface Tuple2D<ImmutablePoint2D>

Returns:

the x coordinate.

ix

@Pure
public int ix()

Description copied from interface: Tuple2D

Get the x coordinate.

Specified by:

ix in interface Tuple2D<ImmutablePoint2D>

Returns:

the x coordinate.

getY

@Pure
public double getY()

Description copied from interface: Tuple2D

Get the y coordinate.

Specified by:

getY in interface Tuple2D<ImmutablePoint2D>

Returns:

the y coordinate.

iy

@Pure
public int iy()

Description copied from interface: Tuple2D

Get the y coordinate.

Specified by:

iy in interface Tuple2D<ImmutablePoint2D>

Returns:

the y coordinate.