Point2D (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.types.custom.Point2D

All Implemented Interfaces:

Serializable, Comparable<Point2D>
```
public class Point2D
extends Object
implements Serializable, Comparable<Point2D>
```
A class that holds a point [x,y] as doubles.
With metods to easy transform it to java.awt.Point and java.awt.geom.Point2D.Double.
But there is supplied the usual methods when working on points.
This is an immutable object. http://www.mymathforum.com/viewtopic.php?f=13&t=8793 http://stattrek.com/regression/regression-example.aspx http://da.wikipedia.org/wiki/Mindste_kvadraters_metode

Since:

1.6

Author:

Frederik Heick

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`VALUE_SEPERATOR` The character use to seperate the X and Y value when making a to string representation or decoding a string representation.

Constructor Summary

Constructors
Constructor and Description
`Point2D()` Default construtor, sets X and Y to 0.
`Point2D(double x, double y)` Constructor with doubles.
`Point2D(int x, int y)` Constructor with integers (int).
`Point2D(Point point)` Construct a Point2D using the values from `java.awt.Point`.
`Point2D(Point2D.Double point)` Construct a Point2D using the values from `java.awt.geom.Point2D.Double`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Point2D o)` Compares the length of a Point3D
`double`	`distance(Point otherPoint)` The distance between two points.
`double`	`distance(Point2D.Double otherPoint)` The distance between two points.
`double`	`distance(Point2D otherPoint)` The distance between two points.
`boolean`	`equals(Object obj)` Determines if this Point2D is equals with either another Point2D,`java.awt.Point` or `java.awt.geom.Point2D.Double`.
`boolean`	`equals(Object obj, double precision)` Compares an other object with this.
`LatLng`	`getAsLatLng()` Get instance of LatLng where X is latitude and Y is longitude.
`Point`	`getAsPoint()` Converts this Point2D to a `java.awt.Point` using the getAsInt methods.
`Point2D.Double`	`getAsPoint2DDouble()` Converts this Point2D to a `java.awt.geom.Point2D.Double`.
`double`	`getLength()` Getting the distance from (0,0) to this point.
`Point2D`	`getUnitVector()` In mathematics, a unit vector in a normed vector space is a vector (often a spatial vector) whose length is 1 (the unit length).
`Double`	`getX()` Gets the X value as a Double
`int`	`getXAsInt()` Gets the X value as an int using `Double.intValue()` method.
`Double`	`getY()` Gets the Y value as a Double
`int`	`getYAsInt()` Gets the Y value as an int using `Double.intValue()` method.
`int`	`hashCode()`
`Point2D`	`scale(double factor)` Scale the values in this Point with factor an returns the result as a new Point.
`String`	`toString()`
`Point2D`	`translate(double dx, double dy)` Translates this point, at location (x,y), by `dx` along the `x` axis and `dy` along the `y` axis so that it now represents the point `(x+dx,y+dy)`.

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

- Field Detail
  - VALUE_SEPERATOR
```
public static final char VALUE_SEPERATOR
```
    The character use to seperate the X and Y value when making a to string representation or decoding a string representation.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Point2D
```
public Point2D()
```
    Default construtor, sets X and Y to 0.
  - Point2D
```
public Point2D(int x,
               int y)
```
    Constructor with integers (int).
    
    Parameters:
    
    x - the x int.
    
    y - the y int.
  - Point2D
```
public Point2D(double x,
               double y)
```
    Constructor with doubles.
    
    Parameters:
    
    x - the x double.
    
    y - the y double.
  - Point2D
```
public Point2D(Point point)
        throws NullPointerException
```
    Construct a Point2D using the values from java.awt.Point.
    
    Parameters:
    
    point - the java.awt.Point
    
    Throws:
    
    NullPointerException - if the Point is null.
    
    See Also:
    
    Point
  - Point2D
```
public Point2D(Point2D.Double point)
        throws NullPointerException
```
    Construct a Point2D using the values from java.awt.geom.Point2D.Double.
    
    Parameters:
    
    point - the java.awt.geom.Point2D.Double.
    
    Throws:
    
    NullPointerException - if the Point is null.
    
    See Also:
    
    Point2D.Double
- Method Detail
  - getX
```
public Double getX()
```
    Gets the X value as a Double
    
    Returns:
    
    the X value.
  - getY
```
public Double getY()
```
    Gets the Y value as a Double
    
    Returns:
    
    the Y value.
  - getXAsInt
```
public int getXAsInt()
```
    Gets the X value as an int using Double.intValue() method.
    
    Returns:
    
    the X value as int.
    
    See Also:
    
    Double.intValue()
  - getYAsInt
```
public int getYAsInt()
```
    Gets the Y value as an int using Double.intValue() method.
    
    Returns:
    
    the Y value as int.
    
    See Also:
    
    Double.intValue()
  - getAsPoint
```
public Point getAsPoint()
```
    Converts this Point2D to a java.awt.Point using the getAsInt methods.
    
    Returns:
    
    a java.awt.Point
    
    See Also:
    
    Point, getXAsInt(), getYAsInt()
  - getAsPoint2DDouble
```
public Point2D.Double getAsPoint2DDouble()
```
    Converts this Point2D to a java.awt.geom.Point2D.Double.
    
    Returns:
    
    a java.awt.geom.Point2D.Double
    
    See Also:
    
    Point2D.Double, Point2D
  - getAsLatLng
```
public LatLng getAsLatLng()
```
    Get instance of LatLng where X is latitude and Y is longitude.
    
    Returns:
    
    a LatLng instance.
  - getLength
```
public double getLength()
```
    Getting the distance from (0,0) to this point.
    
    Returns:
    
    the distance/length of this point using Pythagoras.
  - distance
```
public double distance(Point2D otherPoint)
                throws NullPointerException
```
    The distance between two points.
    
    Parameters:
    
    otherPoint - the other Point2D
    
    Returns:
    
    the distance using Phythagoras.
    
    Throws:
    
    NullPointerException - if the otherPoint is null.
  distance public double distance(Point otherPoint) throws NullPointerException The distance between two points. Parameters: otherPoint - the other Point as java.awt.Point. Returns: the distance using Phythagoras. Throws: NullPointerException - if the otherPoint is null. distance public double distance(Point2D.Double otherPoint) throws NullPointerException The distance between two points. Parameters: otherPoint - the other Point as java.awt.geom.Point2D.Double. Returns: the distance using Phythagoras. Throws: NullPointerException - if the otherPoint is null. scale public Point2D scale(double factor) Scale the values in this Point with factor an returns the result as a new Point. Parameters: factor - the factor the scale the values with. Returns: a new Point2D where the X and Y has be multiplied with the factor. translate public Point2D translate(double dx, double dy) Translates this point, at location (x,y), by dx along the x axis and dy along the y axis so that it now represents the point (x+dx,y+dy). Parameters: dx - the distance to move this point along the X axis dy - the distance to move this point along the Y axis Returns: the result as new Point2D(x+dx,y+dy). getUnitVector public Point2D getUnitVector() In mathematics, a unit vector in a normed vector space is a vector (often a spatial vector) whose length is 1 (the unit length). so this is there result of all the values being divived by the the length. Returns: the Point2D as a unit vector. equals public boolean equals(Object obj) Determines if this Point2D is equals with either another Point2D,java.awt.Point or java.awt.geom.Point2D.Double. Using the PropertyFrameworkGlobals.getDoublePrecision() Double comparator delta. Overrides: equals in class Object See Also: equals(Object, double), {@inheritDoc} equals public boolean equals(Object obj, double precision) Compares an other object with this. Parameters: obj - the other object precision - the precesion at shall compare the doubles values with. Returns: false if obj is null or not of type (Point2D, java.awt.Point or java.awt.geom.Point2D.Double). Otherwise it compare the values from Point2D, java.awt.Point or java.awt.geom.Point2D.Double. hashCode public int hashCode() Overrides: hashCode in class Object toString public String toString() Overrides: toString in class Object compareTo public int compareTo(Point2D o) Compares the length of a Point3D Specified by: compareTo in interface Comparable<Point2D>

Class Point2D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VALUE_SEPERATOR

Constructor Detail

Point2D

Point2D

Point2D

Point2D

Point2D

Method Detail

getX

getY

getXAsInt

getYAsInt

getAsPoint

getAsPoint2DDouble

getAsLatLng

getLength

distance

distance

distance

scale

translate

getUnitVector

equals

equals

hashCode

toString

compareTo