JavaFX 24 · javafx.geometry.Point2D · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private int	hash Cache the hash code to make computing hashes faster.
private final double	x The x coordinate.
private final double	y The y coordinate.
public static final Point2D	ZERO Point or vector with both coordinates set to 0.

Access	Constructor and Description
public	Point2D(double the x coordinate of the point x, double the y coordinate of the point y) Creates a new instance of `Point2D`.

Method Summary

Modifier and Type	Method and Description
public Point2D	Returns: the point with added coordinates add(double the X coordinate addition x, double the Y coordinate addition y) Returns a point with the specified coordinates added to the coordinates of this point.
public Point2D	Returns: the point with added coordinates add(Point2D the point whose coordinates are to be added point) Returns a point with the coordinates of the specified point added to the coordinates of this point.
public double	Returns: the angle between the two vectors measured in degrees angle(double the X magnitude of the other vector x, double the Y magnitude of the other vector y) Computes the angle (in degrees) between the vector represented by this point and the specified vector.
public double	Returns: the angle between the two vectors measured in degrees, `NaN` if any of the two vectors is a zero vector angle(Point2D the other vector point) Computes the angle (in degrees) between the vector represented by this point and the vector represented by the specified point.
public double	Returns: angle between the vectors (this, p1) and (this, p2) measured in degrees, `NaN` if the three points are not different from one another angle(Point2D one point p1, Point2D other point p2) Computes the angle (in degrees) between the three points with this point as a vertex.
public Point3D	Returns: the cross product of the two vectors crossProduct(double the X magnitude of the other vector x, double the Y magnitude of the other vector y) Computes cross product of the vector represented by this instance and the specified vector.
public Point3D	Returns: the cross product of the two vectors crossProduct(Point2D the other vector vector) Computes cross product of the vector represented by this instance and the specified vector.
public double	Returns: the distance between this point and point `(x1, y1)`. distance(double the x coordinate of other point x1, double the y coordinate of other point y1) Computes the distance between this point and point `(x1, y1)`.
public double	Returns: the distance between this point and the specified `point`. distance(Point2D the other point point) Computes the distance between this point and the specified `point`.
public double	Returns: the dot product of the two vectors dotProduct(double the X magnitude of the other vector x, double the Y magnitude of the other vector y) Computes dot (scalar) product of the vector represented by this instance and the specified vector.
public double	Returns: the dot product of the two vectors dotProduct(Point2D the other vector vector) Computes dot (scalar) product of the vector represented by this instance and the specified vector.
public boolean	Returns: true if this point is the same as the obj argument; false otherwise equals(Object the reference object with which to compare obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final double	Returns: the x coordinate getX() The x coordinate.
public final double	Returns: the y coordinate getY() The y coordinate.
public int	Returns: a hash code value for the point. hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the point.
public Point2D	interpolate(Point2D the target value endValue, double the interpolation factor t) Implements javafx.animation.Interpolatable.interpolate. Returns an intermediate value between the value of this `Interpolatable` and the specified `endValue` using the linear interpolation factor `t`, ranging from 0 (inclusive) to 1 (inclusive).
public double	Returns: magnitude of the vector magnitude() Computes magnitude (length) of the relative magnitude vector represented by this instance.
public Point2D	Returns: the point in the middle midpoint(double the X coordinate of the second endpoint x, double the Y coordinate of the second endpoint y) Returns a point which lies in the middle between this point and the specified coordinates.
public Point2D	Returns: the point in the middle midpoint(Point2D the other endpoint point) Returns a point which lies in the middle between this point and the specified point.
public Point2D	Returns: the point with multiplied coordinates multiply(double the factor multiplying the coordinates factor) Returns a point with the coordinates of this point multiplied by the specified factor
public Point2D	Returns: the normalized vector represented by a `Point2D` instance normalize() Normalizes the relative magnitude vector represented by this instance.
public Point2D	Returns: the point with subtracted coordinates subtract(double the X coordinate subtraction x, double the Y coordinate subtraction y) Returns a point with the specified coordinates subtracted from the coordinates of this point.
public Point2D	Returns: the point with subtracted coordinates subtract(Point2D the point whose coordinates are to be subtracted point) Returns a point with the coordinates of the specified point subtracted from the coordinates of this point.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of this `Point2D`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

hash	back to summary
private int hash Cache the hash code to make computing hashes faster.

x	back to summary
private final double x The x coordinate. Default Value 0.0

y	back to summary
private final double y The y coordinate. Default Value 0.0

ZERO	back to summary
public static final Point2D ZERO Point or vector with both coordinates set to 0.

Point2D	back to summary
public Point2D(double x, double y) Creates a new instance of `Point2D`. Parameters x:double the x coordinate of the point y:double the y coordinate of the point

Method Detail

add	back to summary
public Point2D add(double x, double y) Returns a point with the specified coordinates added to the coordinates of this point. Parameters x:double the X coordinate addition y:double the Y coordinate addition Returns:Point2D the point with added coordinates Since JavaFX 8.0

add

back to summary

public Point2D add(double x, double y)

Returns a point with the specified coordinates added to the coordinates of this point.

Parameters

x:double: the X coordinate addition
y:double: the Y coordinate addition

Returns:Point2D

the point with added coordinates

Since

JavaFX 8.0

add back to summary

add	back to summary
public Point2D add(Point2D point) Returns a point with the coordinates of the specified point added to the coordinates of this point. Parameters point:Point2D the point whose coordinates are to be added Returns:Point2D the point with added coordinates Exceptions NullPointerException: if the specified `point` is null Since JavaFX 8.0

public Point2D add(Point2D point)

Returns a point with the coordinates of the specified point added to the coordinates of this point.

Parameters

point:Point2D: the point whose coordinates are to be added

Returns:Point2D

the point with added coordinates

Exceptions

NullPointerException:: if the specified point is null

Since

JavaFX 8.0

angle	back to summary
public double angle(double x, double y) Computes the angle (in degrees) between the vector represented by this point and the specified vector. Parameters x:double the X magnitude of the other vector y:double the Y magnitude of the other vector Returns:double the angle between the two vectors measured in degrees Since JavaFX 8.0

angle

back to summary

public double angle(double x, double y)

Computes the angle (in degrees) between the vector represented by this point and the specified vector.

Parameters

x:double: the X magnitude of the other vector
y:double: the Y magnitude of the other vector

Returns:double

the angle between the two vectors measured in degrees

Since

JavaFX 8.0

angle back to summary

angle	back to summary
public double angle(Point2D point) Computes the angle (in degrees) between the vector represented by this point and the vector represented by the specified point. Parameters point:Point2D the other vector Returns:double the angle between the two vectors measured in degrees, `NaN` if any of the two vectors is a zero vector Exceptions NullPointerException: if the specified `point` is null Since JavaFX 8.0

public double angle(Point2D point)

Computes the angle (in degrees) between the vector represented by this point and the vector represented by the specified point.

Parameters

point:Point2D: the other vector

Returns:double

the angle between the two vectors measured in degrees, NaN if any of the two vectors is a zero vector

Exceptions

NullPointerException:: if the specified point is null

Since

JavaFX 8.0

angle back to summary

angle	back to summary
public double angle(Point2D p1, Point2D p2) Computes the angle (in degrees) between the three points with this point as a vertex. Parameters p1:Point2D one point p2:Point2D other point Returns:double angle between the vectors (this, p1) and (this, p2) measured in degrees, `NaN` if the three points are not different from one another Exceptions NullPointerException: if `p1` or `p2` is null Since JavaFX 8.0

public double angle(Point2D p1, Point2D p2)

Computes the angle (in degrees) between the three points with this point as a vertex.

Parameters

p1:Point2D: one point
p2:Point2D: other point

Returns:double

angle between the vectors (this, p1) and (this, p2) measured in degrees, NaN if the three points are not different from one another

Exceptions

NullPointerException:: if p1 or p2 is null

Since

JavaFX 8.0

crossProduct	back to summary
public Point3D crossProduct(double x, double y) Computes cross product of the vector represented by this instance and the specified vector. Parameters x:double the X magnitude of the other vector y:double the Y magnitude of the other vector Returns:Point3D the cross product of the two vectors Since JavaFX 8.0

crossProduct

back to summary

public Point3D crossProduct(double x, double y)

Computes cross product of the vector represented by this instance and the specified vector.

Parameters

x:double: the X magnitude of the other vector
y:double: the Y magnitude of the other vector

Returns:Point3D

the cross product of the two vectors

Since

JavaFX 8.0

crossProduct back to summary

crossProduct	back to summary
public Point3D crossProduct(Point2D vector) Computes cross product of the vector represented by this instance and the specified vector. Parameters vector:Point2D the other vector Returns:Point3D the cross product of the two vectors Exceptions NullPointerException: if the specified `vector` is null Since JavaFX 8.0

public Point3D crossProduct(Point2D vector)

Computes cross product of the vector represented by this instance and the specified vector.

Parameters

vector:Point2D: the other vector

Returns:Point3D

the cross product of the two vectors

Exceptions

NullPointerException:: if the specified vector is null

Since

JavaFX 8.0

distance back to summary

distance	back to summary
public double distance(double x1, double y1) Computes the distance between this point and point `(x1, y1)`. Parameters x1:double the x coordinate of other point y1:double the y coordinate of other point Returns:double the distance between this point and point `(x1, y1)`.

public double distance(double x1, double y1)

Computes the distance between this point and point (x1, y1).

Parameters

x1:double: the x coordinate of other point
y1:double: the y coordinate of other point

Returns:double

the distance between this point and point (x1, y1).

distance back to summary

distance	back to summary
public double distance(Point2D point) Computes the distance between this point and the specified `point`. Parameters point:Point2D the other point Returns:double the distance between this point and the specified `point`. Exceptions NullPointerException: if the specified `point` is null

public double distance(Point2D point)

Computes the distance between this point and the specified point.

Parameters

point:Point2D: the other point

Returns:double

the distance between this point and the specified point.

Exceptions

NullPointerException:: if the specified point is null

dotProduct	back to summary
public double dotProduct(double x, double y) Computes dot (scalar) product of the vector represented by this instance and the specified vector. Parameters x:double the X magnitude of the other vector y:double the Y magnitude of the other vector Returns:double the dot product of the two vectors Since JavaFX 8.0

dotProduct

back to summary

public double dotProduct(double x, double y)

Computes dot (scalar) product of the vector represented by this instance and the specified vector.

Parameters

x:double: the X magnitude of the other vector
y:double: the Y magnitude of the other vector

Returns:double

the dot product of the two vectors

Since

JavaFX 8.0

dotProduct back to summary

dotProduct	back to summary
public double dotProduct(Point2D vector) Computes dot (scalar) product of the vector represented by this instance and the specified vector. Parameters vector:Point2D the other vector Returns:double the dot product of the two vectors Exceptions NullPointerException: if the specified `vector` is null Since JavaFX 8.0

public double dotProduct(Point2D vector)

Computes dot (scalar) product of the vector represented by this instance and the specified vector.

Parameters

vector:Point2D: the other vector

Returns:double

the dot product of the two vectors

Exceptions

NullPointerException:: if the specified vector is null

Since

JavaFX 8.0

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one. Parameters obj:Object the reference object with which to compare Returns:boolean true if this point is the same as the obj argument; false otherwise Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

Parameters

obj:Object: the reference object with which to compare

Returns:boolean

true if this point is the same as the obj argument; false otherwise

Annotations

@Override

getX	back to summary
public final double getX() The x coordinate. Returns:double the x coordinate

getX

back to summary

public final double getX()

The x coordinate.

Returns:double: the x coordinate

getY	back to summary
public final double getY() The y coordinate. Returns:double the y coordinate

getY

back to summary

public final double getY()

The y coordinate.

Returns:double: the y coordinate

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the point. Returns:int a hash code value for the point. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the point.

Returns:int

a hash code value for the point.

Annotations

@Override

interpolate back to summary

interpolate	back to summary
public Point2D interpolate(Point2D endValue, double t) Implements javafx.animation.Interpolatable.interpolate. Doc from javafx.animation.Interpolatable.interpolate. Returns an intermediate value between the value of this `Interpolatable` and the specified `endValue` using the linear interpolation factor `t`, ranging from 0 (inclusive) to 1 (inclusive). The returned value might not be a new instance; the implementation might also return one of the two existing instances if the intermediate value would be equal to one of the existing values. However, this is an optimization and applications should not assume any particular identity of the returned value. Parameters endValue:Point2D the target value t:double the interpolation factor Returns:Point2D the intermediate value Annotations @Override Exceptions NullPointerException: if `endValue` is `null` Since 13

public Point2D interpolate(Point2D endValue, double t)

Implements javafx.animation.Interpolatable.interpolate.

Doc from javafx.animation.Interpolatable.interpolate.

Returns an intermediate value between the value of this Interpolatable and the specified endValue using the linear interpolation factor t, ranging from 0 (inclusive) to 1 (inclusive).

The returned value might not be a new instance; the implementation might also return one of the two existing instances if the intermediate value would be equal to one of the existing values. However, this is an optimization and applications should not assume any particular identity of the returned value.

Parameters

endValue:Point2D: the target value
t:double: the interpolation factor

Returns:Point2D

the intermediate value

Annotations

@Override

Exceptions

NullPointerException:: if endValue is null

Since

magnitude	back to summary
public double magnitude() Computes magnitude (length) of the relative magnitude vector represented by this instance. Returns:double magnitude of the vector Since JavaFX 8.0

magnitude

back to summary

public double magnitude()

Computes magnitude (length) of the relative magnitude vector represented by this instance.

Returns:double: magnitude of the vector
Since: JavaFX 8.0

midpoint	back to summary
public Point2D midpoint(double x, double y) Returns a point which lies in the middle between this point and the specified coordinates. Parameters x:double the X coordinate of the second endpoint y:double the Y coordinate of the second endpoint Returns:Point2D the point in the middle Since JavaFX 8.0

midpoint

back to summary

public Point2D midpoint(double x, double y)

Returns a point which lies in the middle between this point and the specified coordinates.

Parameters

x:double: the X coordinate of the second endpoint
y:double: the Y coordinate of the second endpoint

Returns:Point2D

the point in the middle

Since

JavaFX 8.0

midpoint back to summary

midpoint	back to summary
public Point2D midpoint(Point2D point) Returns a point which lies in the middle between this point and the specified point. Parameters point:Point2D the other endpoint Returns:Point2D the point in the middle Exceptions NullPointerException: if the specified `point` is null Since JavaFX 8.0

public Point2D midpoint(Point2D point)

Returns a point which lies in the middle between this point and the specified point.

Parameters

point:Point2D: the other endpoint

Returns:Point2D

the point in the middle

Exceptions

NullPointerException:: if the specified point is null

Since

JavaFX 8.0

multiply	back to summary
public Point2D multiply(double factor) Returns a point with the coordinates of this point multiplied by the specified factor Parameters factor:double the factor multiplying the coordinates Returns:Point2D the point with multiplied coordinates Since JavaFX 8.0

multiply

back to summary

public Point2D multiply(double factor)

Returns a point with the coordinates of this point multiplied by the specified factor

Parameters

factor:double: the factor multiplying the coordinates

Returns:Point2D

the point with multiplied coordinates

Since

JavaFX 8.0

normalize back to summary

normalize	back to summary
public Point2D normalize() Normalizes the relative magnitude vector represented by this instance. Returns a vector with the same direction and magnitude equal to 1. If this is a zero vector, a zero vector is returned. Returns:Point2D the normalized vector represented by a `Point2D` instance Since JavaFX 8.0

public Point2D normalize()

Normalizes the relative magnitude vector represented by this instance. Returns a vector with the same direction and magnitude equal to 1. If this is a zero vector, a zero vector is returned.

Returns:Point2D: the normalized vector represented by a Point2D instance
Since: JavaFX 8.0

subtract	back to summary
public Point2D subtract(double x, double y) Returns a point with the specified coordinates subtracted from the coordinates of this point. Parameters x:double the X coordinate subtraction y:double the Y coordinate subtraction Returns:Point2D the point with subtracted coordinates Since JavaFX 8.0

subtract

back to summary

public Point2D subtract(double x, double y)

Returns a point with the specified coordinates subtracted from the coordinates of this point.

Parameters

x:double: the X coordinate subtraction
y:double: the Y coordinate subtraction

Returns:Point2D

the point with subtracted coordinates

Since

JavaFX 8.0

subtract back to summary

subtract	back to summary
public Point2D subtract(Point2D point) Returns a point with the coordinates of the specified point subtracted from the coordinates of this point. Parameters point:Point2D the point whose coordinates are to be subtracted Returns:Point2D the point with subtracted coordinates Exceptions NullPointerException: if the specified `point` is null Since JavaFX 8.0

public Point2D subtract(Point2D point)

Returns a point with the coordinates of the specified point subtracted from the coordinates of this point.

Parameters

point:Point2D: the point whose coordinates are to be subtracted

Returns:Point2D

the point with subtracted coordinates

Exceptions

NullPointerException:: if the specified point is null

Since

JavaFX 8.0

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this `Point2D`. This method is intended to be used only for informational purposes. The content and format of the returned string might vary between implementations. The returned string might be empty but cannot be `null`. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this Point2D. This method is intended to be used only for informational purposes. The content and format of the returned string might vary between implementations. The returned string might be empty but cannot be null.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class Point2D

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail