OTSPoint3D (Open Traffic Sim core classes 0.04.02 API)

java.lang.Object
- org.opentrafficsim.core.geometry.OTSPoint3D

All Implemented Interfaces:

Serializable, LocatableInterface
```
public class OTSPoint3D
extends Object
implements LocatableInterface, Serializable
```
An OTSPoint3D implements a 3D-coordinate for OTS. X, y and z are stored as doubles, but it is assumed that the scale is in SI units, i.e. in meters. A distance between two points is therefore also in meters.
Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-16 10:20:53 +0200 (Thu, 16 Jul 2015) $, @version $Revision: 1124 $, by $Author: pknoppers $, initial version Jul 22, 2015

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`x` the internal representation of the point; x-coordinate.
`double`	`y` the internal representation of the point; y-coordinate.
`double`	`z` the internal representation of the point; z-coordinate.

Constructor Summary

Constructors
Constructor and Description
`OTSPoint3D(CartesianPoint point)`
`OTSPoint3D(com.vividsolutions.jts.geom.Coordinate coordinate)`
`OTSPoint3D(DirectedPoint point)`
`OTSPoint3D(double[] xyz)`
`OTSPoint3D(double x, double y)` The x and y in the point are assumed to be in meters relative to an origin.
`OTSPoint3D(double x, double y, double z)` The x, y and z in the point are assumed to be in meters relative to an origin.
`OTSPoint3D(OTSPoint3D point)`
`OTSPoint3D(com.vividsolutions.jts.geom.Point point)`
`OTSPoint3D(Point2D point2d)`
`OTSPoint3D(Point3d point)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.djunits.value.vdouble.scalar.Length.Rel`	`distance(OTSPoint3D point)`
`double`	`distanceSI(OTSPoint3D point)`
`boolean`	`equals(Object obj)`
`Bounds`	`getBounds()` This method returns a sphere with a diameter of half a meter as the default bounds for a point.
`com.vividsolutions.jts.geom.Coordinate`	`getCoordinate()`
`DirectedPoint`	`getDirectedPoint()`
`DirectedPoint`	`getLocation()`
`int`	`hashCode()`
`String`	`toString()`

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

- Field Detail
  - x
```
public final double x
```
    the internal representation of the point; x-coordinate.
  - y
```
public final double y
```
    the internal representation of the point; y-coordinate.
  - z
```
public final double z
```
    the internal representation of the point; z-coordinate.
- Constructor Detail
  - OTSPoint3D
```
public OTSPoint3D(double x,
                  double y,
                  double z)
```
    The x, y and z in the point are assumed to be in meters relative to an origin.
    
    Parameters:
    
    x - x-coordinate
    
    y - y-coordinate
    
    z - z-coordinate
  - OTSPoint3D
```
public OTSPoint3D(double[] xyz)
```
    Parameters:
    
    xyz - array with three elements; x, y and z are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(OTSPoint3D point)
```
    Parameters:
    
    point - a point to "clone".
  - OTSPoint3D
```
public OTSPoint3D(Point3d point)
```
    Parameters:
    
    point - javax.vecmath 3D double point; the x, y and z in the point are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(CartesianPoint point)
```
    Parameters:
    
    point - javax.vecmath 3D double point; the x, y and z in the point are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(DirectedPoint point)
```
    Parameters:
    
    point - javax.vecmath 3D double point; the x, y and z in the point are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(Point2D point2d)
```
    Parameters:
    
    point2d - java.awt 2D point, z-coordinate will be zero; the x and y in the point are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(com.vividsolutions.jts.geom.Coordinate coordinate)
```
    Parameters:
    
    coordinate - geotools coordinate; the x, y and z in the coordinate are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(com.vividsolutions.jts.geom.Point point)
```
    Parameters:
    
    point - geotools point; z-coordinate will be zero; the x and y in the point are assumed to be in meters relative to an origin.
  - OTSPoint3D
```
public OTSPoint3D(double x,
                  double y)
```
    The x and y in the point are assumed to be in meters relative to an origin. z will be set to 0.
    
    Parameters:
    
    x - x-coordinate
    
    y - y-coordinate
- Method Detail
  - distanceSI
```
public final double distanceSI(OTSPoint3D point)
```
    Parameters:
    
    point - the point to which the distance has to be calculated.
    
    Returns:
    
    the distance in 3D according to Pythagoras, expressed in SI units
  - distance
```
public final org.djunits.value.vdouble.scalar.Length.Rel distance(OTSPoint3D point)
```
    Parameters:
    
    point - the point to which the distance has to be calculated.
    
    Returns:
    
    the distance in 3D according to Pythagoras
  - getCoordinate
```
public final com.vividsolutions.jts.geom.Coordinate getCoordinate()
```
    Returns:
    
    the equivalent geotools Coordinate of this point.
  - getDirectedPoint
```
public final DirectedPoint getDirectedPoint()
```
    Returns:
    
    the equivalent DSOL DirectedPoint of this point.
  - getLocation
```
public final DirectedPoint getLocation()
```
    Specified by:
    
    getLocation in interface LocatableInterface
  - getBounds
```
public final Bounds getBounds()
```
    This method returns a sphere with a diameter of half a meter as the default bounds for a point.
    
    Specified by:
    
    getBounds in interface LocatableInterface
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class OTSPoint3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

z

Constructor Detail

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

OTSPoint3D

Method Detail

distanceSI

distance

getCoordinate

getDirectedPoint

getLocation

getBounds

toString

hashCode

equals