OTSPoint3D (Open Traffic Sim core classes 0.03.03 API)

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

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface, org.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, OTS_SCALAR
```
public class OTSPoint3D
extends Object
implements nl.tudelft.simulation.dsol.animation.LocatableInterface, Serializable, OTS_SCALAR
```
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

Nested Class Summary
- Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR
  org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Acceleration, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AnglePlane, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSlope, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.AngleSolid, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Area, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Density, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Dimensionless, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCharge, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalCurrent, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalPotential, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.ElectricalResistance, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Energy, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowMass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.FlowVolume, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Force, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Frequency, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Length, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.LinearDensity, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Mass, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Power, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Pressure, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Speed, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Temperature, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Time, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Torque, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR.Volume

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.

Fields inherited from interface org.djunits.unit.UNITS
ABAMPERE, ABCOULOMB, ABVOLT, ACRE, AMPERE, ARCMINUTE, ARCSECOND, ARE, ATMOSPHERE_STANDARD, ATMOSPHERE_TECHNICAL, ATOMIC_UNIT, BAR, BARYE, BTU_ISO, BTU_IT, CALORIE_IT, CENTESIMAL_ARCMINUTE, CENTESIMAL_ARCSECOND, CENTIMETER, CENTIMETER_MERCURY, COULOMB, CUBIC_CENTIMETER, CUBIC_DECIMETER, CUBIC_FEET_PER_MINUTE, CUBIC_FEET_PER_SECOND, CUBIC_FOOT, CUBIC_INCH, CUBIC_INCH_PER_MINUTE, CUBIC_INCH_PER_SECOND, CUBIC_KM, CUBIC_METER, CUBIC_METER_PER_DAY, CUBIC_METER_PER_HOUR, CUBIC_METER_PER_MINUTE, CUBIC_METER_PER_SECOND, CUBIC_MILE, CUBIC_YARD, DALTON, DAY, DECIMETER, DEG, DEGREE, DEGREE_CELSIUS, DEGREE_FAHRENHEIT, DEGREE_RANKINE, DEGREE_REAUMUR, DEKAMETER, DYNE, ELECTRONVOLT, EMU, ERG, ERG_PER_SECOND, ESU, EXA_ELECTRONVOLT, FARADAY, FOOT, FOOT_MERCURY, FOOT_PER_SECOND, FOOT_PER_SECOND_2, FOOT_POUND_FORCE, FOOT_POUND_FORCE_PER_HOUR, FOOT_POUND_FORCE_PER_MINUTE, FOOT_POUND_FORCE_PER_SECOND, FRANKLIN, GAL, GALLON_IMP, GALLON_PER_DAY, GALLON_PER_HOUR, GALLON_PER_MINUTE, GALLON_PER_SECOND, GALLON_US_FLUID, GIGA_ELECTRONVOLT, GIGAHERTZ, GIGAWATT, GIGAWATT_HOUR, GRAD, GRAM, GRAM_PER_CENTIMETER_3, HECTARE, HECTOMETER, HECTOPASCAL, HERTZ, HORSEPOWER_METRIC, HOUR, INCH, INCH_MERCURY, INCH_PER_SECOND_2, INCH_POUND_FORCE, JOULE, KELVIN, KG_PER_METER_3, KGF_PER_SQUARE_MM, KILO_ELECTRONVOLT, KILOAMPERE, KILOCALORIE, KILOGRAM, KILOGRAM_FORCE, KILOGRAM_PER_SECOND, KILOHERTZ, KILOMETER, KILOOHM, KILOPASCAL, KILOVOLT, KILOWATT, KILOWATT_HOUR, KM_PER_HOUR, KM_PER_HOUR_2, KNOT, KNOT_PER_SECOND, LITER, LITER_PER_DAY, LITER_PER_HOUR, LITER_PER_MINUTE, LITER_PER_SECOND, MEGA_ELECTRONVOLT, MEGAHERTZ, MEGAOHM, MEGAVOLT, MEGAWATT, MEGAWATT_HOUR, METER, METER_KILOGRAM_FORCE, METER_PER_SECOND, METER_PER_SECOND_2, MICROAMPERE, MICROVOLT, MICROWATT_HOUR, MILE, MILE_PER_HOUR, MILE_PER_HOUR_2, MILE_PER_HOUR_PER_SECOND, MILLI_ELECTRONVOLT, MILLIAMPERE, MILLIAMPERE_HOUR, MILLIBAR, MILLIMETER, MILLIMETER_MERCURY, MILLIOHM, MILLISECOND, MILLIVOLT, MILLIWATT_HOUR, MINUTE, NANOAMPERE, NAUTICAL_MILE, NEWTON, NEWTON_METER, OHM, OUNCE, OUNCE_FORCE, OUNCE_IMP_FLUID, OUNCE_US_FLUID, PASCAL, PER_CENTIMETER, PER_DAY, PER_DECIMETER, PER_DEKAMETER, PER_FOOT, PER_HECTOMETER, PER_HOUR, PER_INCH, PER_KILOMETER, PER_METER, PER_MILE, PER_MILLIMETER, PER_MILLISECOND, PER_MINUTE, PER_NAUTICAL_MILE, PER_SECOND, PER_WEEK, PER_YARD, PETA_ELECTRONVOLT, PIEZE, PINT_IMP, PINT_US_FLUID, POUND, POUND_FOOT, POUND_FORCE, POUND_INCH, POUND_PER_SECOND, POUND_PER_SQUARE_FOOT, POUND_PER_SQUARE_INCH, QUART_IMP, QUART_US_FLUID, RAD, RADIAN, RPM, SECOND, SLOPE_ARCMINUTE, SLOPE_ARCSECOND, SLOPE_CENTESIMAL_ARCMINUTE, SLOPE_CENTESIMAL_ARCSECOND, SLOPE_DEGREE, SLOPE_GRAD, SLOPE_RADIAN, SQUARE_CENTIMETER, SQUARE_DEGREE, SQUARE_FOOT, SQUARE_INCH, SQUARE_METER, SQUARE_MILE, SQUARE_MILLIMETER, SQUARE_YARD, STANDARD_GRAVITY, STATAMPERE, STATCOULOMB, STATVOLT, STERADIAN, STHENE, STHENE_METER, STHENE_METER_PER_SECOND, TERA_ELECTRONVOLT, TERAHERTZ, TERAWATT_HOUR, TON_FORCE, TON_LONG, TON_METRIC, TON_SHORT, TONNE, TORR, VOLT, WATT, WATT_HOUR, WEEK, YARD

Constructor Summary

Constructors
Constructor and Description
`OTSPoint3D(nl.tudelft.simulation.language.d3.CartesianPoint point)`
`OTSPoint3D(com.vividsolutions.jts.geom.Coordinate coordinate)`
`OTSPoint3D(nl.tudelft.simulation.language.d3.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(javax.vecmath.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)`
`javax.media.j3d.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()`
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getDirectedPoint()`
`nl.tudelft.simulation.language.d3.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(javax.vecmath.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(nl.tudelft.simulation.language.d3.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(nl.tudelft.simulation.language.d3.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 nl.tudelft.simulation.language.d3.DirectedPoint getDirectedPoint()
```
    Returns:
    
    the equivalent DSOL DirectedPoint of this point.
  - getLocation
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocation()
```
    Specified by:
    
    getLocation in interface nl.tudelft.simulation.dsol.animation.LocatableInterface
  - getBounds
```
public final javax.media.j3d.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 nl.tudelft.simulation.dsol.animation.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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.DOUBLE_SCALAR

Field Summary

Fields inherited from interface org.djunits.unit.UNITS

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