Point2D32 (euclid-core 0.5.1 API)

java.lang.Object
- us.ihmc.euclid.tuple2D.Point2D32

All Implemented Interfaces:

Clearable, EpsilonComparable<Point2D32>, GeometricallyComparable<Point2D32>, GeometryObject<Point2D32>, Settable<Point2D32>, Transformable, Point2DBasics, Point2DReadOnly, Tuple2DBasics, Tuple2DReadOnly
```
public class Point2D32
extends java.lang.Object
implements Point2DBasics, GeometryObject<Point2D32>
```
A 2D point represents the 2D coordinates of a location on the XY-plane.
This version of 2D point uses single precision fields to save the value of each component. It is meant for garbage free usage and for situations where heap memory is limited. When memory is not a constraint, the use of Point2D is preferable.

Constructor Summary

Constructors
Constructor and Description
`Point2D32()` Creates a new point and initializes it coordinates to zero.
`Point2D32(float[] pointArray)` Creates a new point and initializes its component `x`, `y` in order from the given array.
`Point2D32(float x, float y)` Creates a new point and initializes it with the given coordinates.
`Point2D32(Tuple2DReadOnly other)` Creates a new point and initializes it to `other`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`epsilonEquals(Point2D32 other, double epsilon)` Tests on a per component basis if this point is equal to the given `other` to an `epsilon`.
`boolean`	`equals(java.lang.Object object)` Tests if the given `object`'s class is the same as this, in which case the method returns `Tuple2DReadOnly.equals(Tuple2DReadOnly)`, it returns `false` otherwise.
`boolean`	`geometricallyEquals(Point2D32 other, double epsilon)` Tests if `this` and `other` represent the same point 2D to an `epsilon`.
`double`	`getX()` Returns the value of the x-coordinate of this point.
`float`	`getX32()` Returns the value of the x-coordinate of this point.
`double`	`getY()` Returns the value of the y-coordinate of this point.
`float`	`getY32()` Returns the value of the y-coordinate of this point.
`int`	`hashCode()` Calculates and returns a hash code value from the value of each component of this point 2D.
`void`	`set(Point2D32 other)` Sets this point to `other`.
`void`	`setX(double x)` Sets the x-coordinate of this point.
`void`	`setX(float x)` Sets the x-coordinate of this point.
`void`	`setY(double y)` Sets the y-coordinate of this point.
`void`	`setY(float y)` Sets the y-coordinate of this point.
`java.lang.String`	`toString()` Provides a `String` representation of this point 2D as follows: (x, y).

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

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Point2DBasics
applyInverseTransform, applyInverseTransform, applyTransform, applyTransform

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Tuple2DBasics
absolute, add, add, add, addX, addY, clipToMax, clipToMin, clipToMinMax, containsNaN, interpolate, interpolate, negate, scale, scale, scaleAdd, scaleAdd, scaleSub, scaleSub, set, set, set, set, set, set, set, set, set, set, setAndAbsolute, setAndClipToMax, setAndClipToMin, setAndClipToMinMax, setAndNegate, setAndScale, setElement, setToNaN, setToZero, sub, sub, sub, subX, subY

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Point2DReadOnly
distance, distanceFromOrigin, distanceFromOriginSquared, distanceSquared, distanceXY, distanceXYSquared, geometricallyEquals

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Tuple2DReadOnly
epsilonEquals, equals, get, get, get, get, get, get, get, getElement, getElement32

- Constructor Detail
  - Point2D32
```
public Point2D32()
```
    Creates a new point and initializes it coordinates to zero.
  - Point2D32
```
public Point2D32(float x,
                 float y)
```
    Creates a new point and initializes it with the given coordinates.
    
    Parameters:
    
    x - the x-coordinate.
    
    y - the y-coordinate.
  - Point2D32
```
public Point2D32(float[] pointArray)
```
    Creates a new point and initializes its component x, y in order from the given array.
    
    Parameters:
    
    pointArray - the array containing this point's coordinates. Not modified.
  - Point2D32
```
public Point2D32(Tuple2DReadOnly other)
```
    Creates a new point and initializes it to other.
    
    Parameters:
    
    other - the tuple to copy the coordinates from. Not modified.
- Method Detail
  - set
```
public void set(Point2D32 other)
```
    Sets this point to other.
    
    Specified by:
    
    set in interface Settable<Point2D32>
    
    Parameters:
    
    other - the other point to copy the values from. Not modified.
  - setX
```
public void setX(double x)
```
    Sets the x-coordinate of this point.
    
    Specified by:
    
    setX in interface Tuple2DBasics
    
    Parameters:
    
    x - the x-coordinate.
  - setY
```
public void setY(double y)
```
    Sets the y-coordinate of this point.
    
    Specified by:
    
    setY in interface Tuple2DBasics
    
    Parameters:
    
    y - the y-coordinate.
  - setX
```
public void setX(float x)
```
    Sets the x-coordinate of this point.
    
    Parameters:
    
    x - the x-coordinate.
  - setY
```
public void setY(float y)
```
    Sets the y-coordinate of this point.
    
    Parameters:
    
    y - the y-coordinate.
  - getX
```
public double getX()
```
    Returns the value of the x-coordinate of this point.
    
    Specified by:
    
    getX in interface Tuple2DReadOnly
    
    Returns:
    
    the x-coordinate's value.
  - getY
```
public double getY()
```
    Returns the value of the y-coordinate of this point.
    
    Specified by:
    
    getY in interface Tuple2DReadOnly
    
    Returns:
    
    the y-coordinate's value.
  - getX32
```
public float getX32()
```
    Returns the value of the x-coordinate of this point.
    
    Specified by:
    
    getX32 in interface Tuple2DReadOnly
    
    Returns:
    
    the x-coordinate's value.
  - getY32
```
public float getY32()
```
    Returns the value of the y-coordinate of this point.
    
    Specified by:
    
    getY32 in interface Tuple2DReadOnly
    
    Returns:
    
    the y-coordinate's value.
  - equals
```
public boolean equals(java.lang.Object object)
```
    Tests if the given object's class is the same as this, in which case the method returns Tuple2DReadOnly.equals(Tuple2DReadOnly), it returns false otherwise.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - the object to compare against this. Not modified.
    
    Returns:
    
    true if object and this are exactly equal, false otherwise.
  - epsilonEquals
```
public boolean epsilonEquals(Point2D32 other,
                             double epsilon)
```
    Tests on a per component basis if this point is equal to the given other to an epsilon.
    
    Specified by:
    
    epsilonEquals in interface EpsilonComparable<Point2D32>
    
    Parameters:
    
    other - the other point to compare against this. Not modified.
    
    epsilon - the tolerance to use when comparing each component.
    
    Returns:
    
    true if the two tuples are equal, false otherwise.
  - geometricallyEquals
```
public boolean geometricallyEquals(Point2D32 other,
                                   double epsilon)
```
    Tests if this and other represent the same point 2D to an epsilon.
    Two points are considered geometrically equal if they are at a distance of less than or equal to epsilon.
    
    Note that this.geometricallyEquals(other, epsilon) == true does not necessarily imply this.epsilonEquals(other, epsilon) and vice versa.
    
    Specified by:
    
    geometricallyEquals in interface GeometricallyComparable<Point2D32>
    
    Parameters:
    
    other - the other point 2D to compare against this. Not modified.
    
    epsilon - the maximum distance that the two points can be spaced and still considered equal.
    
    Returns:
    
    true if the two points represent the same geometry, false otherwise.
  - toString
```
public java.lang.String toString()
```
    Provides a String representation of this point 2D as follows: (x, y).
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the String representing this point 2D.
  - hashCode
```
public int hashCode()
```
    Calculates and returns a hash code value from the value of each component of this point 2D.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code value for this point 2D.

Class Point2D32

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Point2DBasics

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Tuple2DBasics

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Point2DReadOnly

Methods inherited from interface us.ihmc.euclid.tuple2D.interfaces.Tuple2DReadOnly

Constructor Detail

Point2D32

Point2D32

Point2D32

Point2D32

Method Detail

set

setX

setY

setX

setY

getX

getY

getX32

getY32

equals

epsilonEquals

geometricallyEquals

toString

hashCode