PointD (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.geometry.PointD

All Implemented Interfaces:

IPoint, com.yworks.yfiles.utils.IStruct, Cloneable
```
public final class PointD
extends Object
implements com.yworks.yfiles.utils.IStruct, IPoint
```
An immutable struct that models a point in 2-d Cartesian coordinate space with double coordinates.
This class implements the IPoint interface so that it can be used in methods that require that interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static PointD`	`ORIGIN` A struct instance that has `x` and `y` set to `0.0d`.
`double`	`x` Gets the X coordinate of the point.
`double`	`y` Gets the Y coordinate of the point.

Constructor Summary

Constructors
Constructor and Description
`PointD()`
`PointD(double x, double y)` Initializes a new instance using the given values for the `x` and `y` properties.
`PointD(IPoint point)` Initializes a new instance using the coordinates of the provided `IPoint`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PointD`	`add(PointD p1, PointD p2)` Implements the vector addition operator.
`PointD`	`clone()`
`static PointD`	`convertFrom(MutablePoint p)` Performs an explicit conversion from `MutablePoint` to `PointD`.
`static MutablePoint`	`convertToMutablePoint(PointD point)` Performs an implicit conversion from `PointD` to `MutablePoint`.
`double`	`distanceTo(PointD other)` Calculates the Euclidean distance to the given point.
`double`	`distanceToSegment(PointD start, PointD end)` Determines the distance between this point and a line segment.
`boolean`	`equals(Object other)` Indicates whether this instance and a specified object are equal.
`static boolean`	`equals(PointD p1, PointD p2)` Implements the operator == which is applied componentwise to `x` and `y`.
`boolean`	`equalsEps(PointD other, double eps)` Determines whether the two given points have the same coordinates with respect to a certain given `eps`.
`PointD`	`getConstrained(RectD rectangle)` Create a constrained copy of this instance that lies within the given non-empty `rectangle`.
`PointD`	`getNormalized()` Gets the normalized version of this vector.
`PointD`	`getProjectionOnLine(PointD anchor, PointD direction)` Calculates the projection of this point onto a line.
`PointD`	`getProjectionOnRay(PointD rayStart, PointD direction)` Calculates the projection of this point onto a ray.
`PointD`	`getProjectionOnSegment(PointD start, PointD end)` Calculates the projection of this point onto a segment.
`double`	`getSquaredVectorLength()` Yields the squared length of the vector that has `x` and `y` as its components.
`double`	`getVectorLength()` Yields the length of the vector that has `x` and `y` as its components.
`double`	`getX()` Gets or sets the X coordinate of the point.
`double`	`getY()` Gets or sets the Y coordinate of the point.
`int`	`hashCode()` Returns the hash code for this instance that is calculated using the `x` and `y` values.
`boolean`	`hits(PointD other, double hitTestRadius)` Determines if the point lies close to this point given an epsilon.
`boolean`	`hitsLineSegment(PointD start, PointD end, double radius)` Determines whether this point hits the line segment with respect to a given `radius`.
`boolean`	`hitsPolyline(Iterable<IPoint> points, double radius)` Determines whether a polygonal line is hit by this point given an epsilon.
`boolean`	`isHorizontalVector()` Indicates whether this instance is a horizontally oriented vector.
`boolean`	`isVerticalVector()` Indicates whether this instance is a vertically oriented vector.
`static PointD`	`multiply(Matrix2D matrix, PointD vector)` Implements the vector transformation by calling `Matrix2D.transform(PointD)`.
`static PointD`	`multiply(PointD point, double factor)` Implements scalar multiplication.
`double`	`scalarProduct(PointD other)` Calculates the scalar product of this and the given vector.
`static double`	`scalarProduct(PointD point1, PointD point2)` Calculates the scalar product of the two given points.
`static PointD`	`subtract(PointD p1, PointD p2)` Implements the vector subtraction operator.
`IMutablePoint`	`toMutablePoint()` Creates an `IMutablePoint` that has the same coordinates as this struct.
`PointD`	`toPointD()` Copies the current values of the coordinates of the point to a `PointD` struct.
`String`	`toString()` Returns a human readable string of this point.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.geometry.IPoint
distanceTo

- Field Detail
  - ORIGIN
```
public static final PointD ORIGIN
```
    A struct instance that has x and y set to 0.0d.
  - x
```
public final double x
```
    Gets the X coordinate of the point.
  - y
```
public final double y
```
    Gets the Y coordinate of the point.
- Constructor Detail
  - PointD
```
public PointD()
```
  - PointD
```
public PointD(double x,
              double y)
```
    Initializes a new instance using the given values for the x and y properties.
    
    Parameters:
    
    x - The x coordinate.
    
    y - The y coordinate.
  - PointD
```
public PointD(IPoint point)
```
    Initializes a new instance using the coordinates of the provided IPoint.
    
    Parameters:
    
    point - The point to get the initial coordinates from.
- Method Detail
  - add
```
public static final PointD add(PointD p1,
                               PointD p2)
```
    Implements the vector addition operator.
    This operator is applied componentwise to x and y.
    
    Parameters:
    
    p1 - The first point.
    
    p2 - The second point.
    
    Returns:
    
    The result of the operation.
  - clone
```
public PointD clone()
```
    Overrides:
    
    clone in class Object
  - convertFrom
```
public static final PointD convertFrom(MutablePoint p)
```
    Performs an explicit conversion from MutablePoint to PointD.
    
    Parameters:
    
    p - The point to convert.
    
    Returns:
    
    The result of the conversion.
  - convertToMutablePoint
```
public static final MutablePoint convertToMutablePoint(PointD point)
```
    Performs an implicit conversion from PointD to MutablePoint.
    
    Parameters:
    
    point - The point to convert.
  - distanceTo
```
public final double distanceTo(PointD other)
```
    Calculates the Euclidean distance to the given point.
    
    Parameters:
    
    other - The other point.
    
    Returns:
    
    The Euclidean distance between the points.
  - distanceToSegment
```
public final double distanceToSegment(PointD start,
                                      PointD end)
```
    Determines the distance between this point and a line segment.
    
    Parameters:
    
    start - The coordinates of the first point of the line.
    
    end - The coordinates of the second point of the line.
    
    Returns:
    
    The distance between this point and the closest point on the line segment.
  - equals
```
public boolean equals(Object other)
```
    Indicates whether this instance and a specified object are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    other - Another object to compare to.
    
    Returns:
    
    true if other and this instance are the same type and represent the same value; otherwise, false.
  - equals
```
public static final boolean equals(PointD p1,
                                   PointD p2)
```
    Implements the operator == which is applied componentwise to x and y.
    
    Parameters:
    
    p1 - The first point.
    
    p2 - The second point.
    
    Returns:
    
    Whether x and y are equal for both points.
  - equalsEps
```
public final boolean equalsEps(PointD other,
                               double eps)
```
    Determines whether the two given points have the same coordinates with respect to a certain given eps.
    
    Parameters:
    
    other - The other point to check for equality against this point.
    
    eps - The epsilon value.
    
    Returns:
    
    Whether both coordinates are equal with respect for the given epsilon.
  - getConstrained
```
public final PointD getConstrained(RectD rectangle)
```
    Create a constrained copy of this instance that lies within the given non-empty rectangle.
    If the given rectangle is RectD.EMPTY, this implementation will silently return.
    
    Parameters:
    
    rectangle - The rectangle to constrain this instance by.
    
    Returns:
    
    A constrained copy of this instance.
  - getNormalized
```
public final PointD getNormalized()
```
    Gets the normalized version of this vector.
    
    Returns:
    
    The normalized version of this vector or (1,0) if this vector has 0.0d length.
  - getProjectionOnLine
```
public final PointD getProjectionOnLine(PointD anchor,
                                        PointD direction)
```
    Calculates the projection of this point onto a line.
    
    Parameters:
    
    anchor - An anchor for the infinite line.
    
    direction - A direction vector for the infinite line.
    
    Returns:
    
    The point on the line that is closest to this point.
  - getProjectionOnRay
```
public final PointD getProjectionOnRay(PointD rayStart,
                                       PointD direction)
```
    Calculates the projection of this point onto a ray.
    If the perpendicular projection onto the line is outside of the ray ("behind" the rayStart) the rayStart is returned instead.
    
    Parameters:
    
    rayStart - The start of the segment.
    
    direction - The direction of the ray.
    
    Returns:
    
    The point on the ray that is closest to this point.
  - getProjectionOnSegment
```
public final PointD getProjectionOnSegment(PointD start,
                                           PointD end)
```
    Calculates the projection of this point onto a segment.
    If the perpendicular projection onto the line is outside of the segment the nearest segment endpoint is returned.
    
    Parameters:
    
    start - The start of the segment.
    
    end - The end of the segment.
    
    Returns:
    
    The point on the segment that is closest to this point.
  - getSquaredVectorLength
```
public final double getSquaredVectorLength()
```
    Yields the squared length of the vector that has x and y as its components.
    
    Returns:
    
    The squared length of the vector which is X*X + Y*Y.
  - getVectorLength
```
public final double getVectorLength()
```
    Yields the length of the vector that has x and y as its components.
    
    Returns:
    
    The length of the vector which is the square root of X*X + Y*Y.
  - getX
```
public final double getX()
```
    Gets or sets the X coordinate of the point.
    
    Specified by:
    
    getX in interface IPoint
    
    Returns:
    
    The X coordinate.
  - getY
```
public final double getY()
```
    Gets or sets the Y coordinate of the point.
    
    Specified by:
    
    getY in interface IPoint
    
    Returns:
    
    The Y coordinate.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this instance that is calculated using the x and y values.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A 32-bit signed integer that is the hash code for this instance.
  - hits
```
public final boolean hits(PointD other,
                          double hitTestRadius)
```
    Determines if the point lies close to this point given an epsilon.
    
    Parameters:
    
    other - The coordinates of the other point.
    
    hitTestRadius - The hit test epsilon.
    
    Returns:
    
    Whether the distance between the two points is smaller than hitTestRadius
  - hitsLineSegment
```
public final boolean hitsLineSegment(PointD start,
                                     PointD end,
                                     double radius)
```
    Determines whether this point hits the line segment with respect to a given radius.
    
    Parameters:
    
    start - The starting point of the line segment to test.
    
    end - The ending point of the line segment to test.
    
    radius - The hit test radius.
    
    Returns:
    
    Whether this point hits the given line segment within the radius.
  - hitsPolyline
```
public final boolean hitsPolyline(Iterable<IPoint> points,
                                  double radius)
```
    Determines whether a polygonal line is hit by this point given an epsilon.
    
    Parameters:
    
    points - The list of points that is treated as a polygon
    
    radius - A positive value allows for fuzzy hit testing. If the point lies outside the given object but it's distance is less than or equal to that value, it will be considered a hit.
    
    Returns:
    
    Whether the point hits the polygon.
  - isHorizontalVector
```
public final boolean isHorizontalVector()
```
    Indicates whether this instance is a horizontally oriented vector.
    
    Returns:
    
    true iff Math.Abs(X) > Math.Abs(Y).
  - isVerticalVector
```
public final boolean isVerticalVector()
```
    Indicates whether this instance is a vertically oriented vector.
    
    Returns:
    
    true iff Math.Abs(Y) > Math.Abs(X).
  - multiply
```
public static final PointD multiply(Matrix2D matrix,
                                    PointD vector)
```
    Implements the vector transformation by calling Matrix2D.transform(PointD).
    
    Parameters:
    
    matrix - The matrix to use for the transformation.
    
    vector - The vector to transform.
    
    Returns:
    
    The result of the transformation.
  - multiply
```
public static final PointD multiply(PointD point,
                                    double factor)
```
    Implements scalar multiplication.
    This factor is applied componentwise to x and y.
    
    Parameters:
    
    point - The point to scale the components of.
    
    factor - The factor to scale the components by.
    
    Returns:
    
    The result of the scalar multiplication.
  - scalarProduct
```
public final double scalarProduct(PointD other)
```
    Calculates the scalar product of this and the given vector.
    
    Parameters:
    
    other - The other vector.
    
    Returns:
    
    The scalar product (X*other.X + Y*other.Y)
  - scalarProduct
```
public static final double scalarProduct(PointD point1,
                                         PointD point2)
```
    Calculates the scalar product of the two given points.
    
    Parameters:
    
    point1 - The first point.
    
    point2 - The second point.
    
    Returns:
    
    The scalar product of the two points.
  - subtract
```
public static final PointD subtract(PointD p1,
                                    PointD p2)
```
    Implements the vector subtraction operator.
    This operator is applied componentwise to x and y.
    
    Parameters:
    
    p1 - The first point.
    
    p2 - The second point.
    
    Returns:
    
    The result of the operation.
  - toMutablePoint
```
public final IMutablePoint toMutablePoint()
```
    Creates an IMutablePoint that has the same coordinates as this struct.
    
    Returns:
    
    A IMutablePoint with the same coordinates.
  - toPointD
```
public PointD toPointD()
```
    Description copied from interface: IPoint
    
    Copies the current values of the coordinates of the point to a PointD struct.
    This method is useful to obtain a copy of the state and for making use of the various utility methods that are provided by PointD.
    
    Specified by:
    
    toPointD in interface IPoint
    
    Returns:
    
    The current values of the coordinates of the point.
    
    See Also:
    
    toMutablePoint(), IMutablePoint.relocate(PointD)
  - toString
```
public String toString()
```
    Returns a human readable string of this point.
    
    Overrides:
    
    toString in class Object

Class PointD

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.geometry.IPoint

Field Detail

ORIGIN

x

y

Constructor Detail

PointD

PointD

PointD

Method Detail

add

clone

convertFrom

convertToMutablePoint

distanceTo

distanceToSegment

equals

equals

equalsEps

getConstrained

getNormalized

getProjectionOnLine

getProjectionOnRay

getProjectionOnSegment

getSquaredVectorLength

getVectorLength

getX

getY

hashCode

hits

hitsLineSegment

hitsPolyline

isHorizontalVector

isVerticalVector

multiply

multiply

scalarProduct

scalarProduct

subtract

toMutablePoint

toPointD

toString