Point (JBotSim Project documentation)

java.lang.Object
- io.jbotsim.core.Point

All Implemented Interfaces:

Serializable
```
public class Point
extends Object
implements Serializable
```
The Point used by JBotSim.

The third dimension is optional. When not provided, it is implicitly set to zero.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

double x

double y

double z

Fields
Modifier and Type	Field and Description
`double`	`x`
`double`	`y`
`double`	`z`

Constructor Summary

Constructors
Constructor and Description
`Point()` Creates a `Point` object.
`Point(double x, double y)` Creates a `Point` object with the provided coordinates.
`Point(double x, double y, double z)` Creates a `Point` object with the provided coordinates.
`Point(Point p)` Copy constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`double`	`distance(double x, double y)` Computes the distance between the current point and the point represented by the provided coordinates.
`double`	`distance(double x, double y, double z)` Computes the distance between the current point and the point represented by the provided coordinates.
`static double`	`distance(double x1, double y1, double x2, double y2)` Computes the distance between two points.
`double`	`distance(Point pt)` Computes the distance between the current point and provided one.
`boolean`	`equals(Object obj)`
`double`	`getX()` Gets the current abscissa.
`double`	`getY()` Gets the current ordinate.
`double`	`getZ()` Gets the current applicate.
`int`	`hashCode()`
`void`	`setLocation(double x, double y)` Changes the current coordinates to those the provided ones.
`protected void`	`setLocation(double x, double y, double z)` Changes the current coordinates to those the provided ones.
`void`	`setLocation(Point p)` Changes the current coordinates to those of the provided `Point`.
`String`	`toString()`

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

- Field Detail
  - x
```
public double x
```
  - y
```
public double y
```
  - z
```
public double z
```
- Constructor Detail
  - Point
```
public Point()
```
    Creates a Point object.
    
    The coordinates correspond to the origin of the system.
  - Point
```
public Point(Point p)
```
    Copy constructor.
    
    Parameters:
    
    p - the Point to copy.
  - Point
```
public Point(double x,
             double y)
```
    Creates a Point object with the provided coordinates.
    
    Parameters:
    
    x - the abscissa, as a double.
    
    y - the ordinate, as a double.
  - Point
```
public Point(double x,
             double y,
             double z)
```
    Creates a Point object with the provided coordinates.
    
    Parameters:
    
    x - the abscissa, as a double.
    
    y - the ordinate, as a double.
    
    z - the applicate, as a double.
- Method Detail
  - distance
```
public static double distance(double x1,
                              double y1,
                              double x2,
                              double y2)
```
    Computes the distance between two points.
    
    Parameters:
    
    x1 - abscissa of the first point, as a double.
    
    y1 - ordinate of the first point, as a double.
    
    x2 - abscissa of the second point, as a double.
    
    y2 - ordinate of the second point, as a double.
    
    Returns:
    
    the distance between the two provided points, as a double.
  - distance
```
public double distance(double x,
                       double y,
                       double z)
```
    Computes the distance between the current point and the point represented by the provided coordinates.
    
    Parameters:
    
    x - the abscissa, as a double.
    
    y - the ordinate, as a double.
    
    z - the applicate, as a double.
    
    Returns:
    
    the distance between the two provided points, as a double.
  - getZ
```
public double getZ()
```
    Gets the current applicate.
    
    Returns:
    
    the current applicate, as a double.
  - getX
```
public double getX()
```
    Gets the current abscissa.
    
    Returns:
    
    the current abscissa, as a double.
  - getY
```
public double getY()
```
    Gets the current ordinate.
    
    Returns:
    
    the current ordinate, as a double.
  - setLocation
```
public void setLocation(Point p)
```
    Changes the current coordinates to those of the provided Point.
    
    Parameters:
    
    p - the Point to copy coordinates from.
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    Changes the current coordinates to those the provided ones.
    
    Parameters:
    
    x - the new abscissa, as a double.
    
    y - the new ordinate, as a double.
  - setLocation
```
protected void setLocation(double x,
                           double y,
                           double z)
```
    Changes the current coordinates to those the provided ones.
    
    Parameters:
    
    x - the new abscissa, as a double.
    
    y - the new ordinate, as a double.
    
    z - the new applicate, as a double.
  - distance
```
public double distance(double x,
                       double y)
```
    Computes the distance between the current point and the point represented by the provided coordinates.
    
    Parameters:
    
    x - the abscissa, as a double.
    
    y - the ordinate, as a double.
    
    Returns:
    
    the distance between the two provided points, as a double.
  - distance
```
public double distance(Point pt)
```
    Computes the distance between the current point and provided one.
    
    Parameters:
    
    pt - the other Point.
    
    Returns:
    
    the distance between the two provided points, as a double.
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Point

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

z

Constructor Detail

Point

Point

Point

Point

Method Detail

distance

distance

getZ

getX

getY

setLocation

setLocation

setLocation

distance

distance

clone

hashCode

equals

toString