OTSLine3D (Open Traffic Sim core classes 0.03.03 API)

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

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface, org.djunits.unit.UNITS, org.djunits.value.vdouble.scalar.DOUBLE_SCALAR, OTS_SCALAR

Direct Known Subclasses:

OTSPolygon3D
```
public class OTSLine3D
extends Object
implements nl.tudelft.simulation.dsol.animation.LocatableInterface, Serializable, OTS_SCALAR
```
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 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
`OTSLine3D(com.vividsolutions.jts.geom.Coordinate[] coordinates)`
`OTSLine3D(com.vividsolutions.jts.geom.Geometry geometry)`
`OTSLine3D(com.vividsolutions.jts.geom.LineString lineString)`
`OTSLine3D(List<OTSPoint3D> pointList)`
`OTSLine3D(OTSPoint3D[] points)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`OTSPoint3D`	`get(int i)`
`javax.media.j3d.Bounds`	`getBounds()`
`com.vividsolutions.jts.geom.Coordinate[]`	`getCoordinates()`
`org.djunits.value.vdouble.scalar.Length.Rel`	`getLength()`
`double`	`getLengthSI()`
`com.vividsolutions.jts.geom.LineString`	`getLineString()`
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocation()`
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocation(org.djunits.value.vdouble.scalar.Length.Rel position)` Get the location at a position on the line, with its direction.
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocationExtended(org.djunits.value.vdouble.scalar.Length.Rel position)` Get the location at a position on the line, with its direction.
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocationExtendedSI(double positionSI)` Get the location at a position on the line, with its direction.
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocationFraction(double fraction)` Get the location at a fraction of the line, with its direction.
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocationSI(double positionSI)` Get the location at a position on the line, with its direction.
`OTSPoint3D[]`	`getPoints()`
`int`	`hashCode()`
`int`	`size()`
`String`	`toString()`

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

- Constructor Detail
  - OTSLine3D
```
public OTSLine3D(OTSPoint3D[] points)
```
    Parameters:
    
    points - the array of points to construct this OTSLine3D from.
  - OTSLine3D
```
public OTSLine3D(com.vividsolutions.jts.geom.Coordinate[] coordinates)
```
    Parameters:
    
    coordinates - the array of coordinates to construct this OTSLine3D from.
  - OTSLine3D
```
public OTSLine3D(com.vividsolutions.jts.geom.LineString lineString)
```
    Parameters:
    
    lineString - the lineString to construct this OTSLine3D from.
  - OTSLine3D
```
public OTSLine3D(com.vividsolutions.jts.geom.Geometry geometry)
```
    Parameters:
    
    geometry - the geometry to construct this OTSLine3D from.
  - OTSLine3D
```
public OTSLine3D(List<OTSPoint3D> pointList)
```
    Parameters:
    
    pointList - the list of points to construct this OTSLine3D from.
- Method Detail
  - getCoordinates
```
public final com.vividsolutions.jts.geom.Coordinate[] getCoordinates()
```
    Returns:
    
    an array of Coordinates corresponding to this OTSLine.
  - getLineString
```
public final com.vividsolutions.jts.geom.LineString getLineString()
```
    Returns:
    
    a LineString corresponding to this OTSLine.
  - size
```
public final int size()
```
    Returns:
    
    the number of points on the line.
  - get
```
public final OTSPoint3D get(int i)
                     throws OTSGeometryException
```
    Parameters:
    
    i - the index of the point to retrieve
    
    Returns:
    
    the i-th point of the line.
    
    Throws:
    
    OTSGeometryException - when i < 0 or i > the number of points
  - getLengthSI
```
public final double getLengthSI()
```
    Returns:
    
    the length of the line in SI units.
  - getLength
```
public final org.djunits.value.vdouble.scalar.Length.Rel getLength()
```
    Returns:
    
    the length of the line.
  - getPoints
```
public final OTSPoint3D[] getPoints()
```
    Returns:
    
    the points of this line.
  - getLocationExtended
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationExtended(org.djunits.value.vdouble.scalar.Length.Rel position)
                                                                          throws NetworkException
```
    Get the location at a position on the line, with its direction. Position can be below 0 or more than the line length. In that case, the position will be extrapolated in the direction of the line at its start or end.
    
    Parameters:
    
    position - the position on the line for which to calculate the point on, before, of after the line
    
    Returns:
    
    a directed point
    
    Throws:
    
    NetworkException - when position could not be calculated
  - getLocationExtendedSI
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationExtendedSI(double positionSI)
                                                                            throws NetworkException
```
    Get the location at a position on the line, with its direction. Position can be below 0 or more than the line length. In that case, the position will be extrapolated in the direction of the line at its start or end.
    
    Parameters:
    
    positionSI - the position on the line for which to calculate the point on, before, of after the line, in SI units
    
    Returns:
    
    a directed point
    
    Throws:
    
    NetworkException - when position could not be calculated
  - getLocationFraction
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationFraction(double fraction)
                                                                          throws NetworkException
```
    Get the location at a fraction of the line, with its direction. Fraction should be between 0.0 and 1.0.
    
    Parameters:
    
    fraction - the fraction for which to calculate the point on the line
    
    Returns:
    
    a directed point
    
    Throws:
    
    NetworkException - when fraction less than 0.0 or more than 1.0.
  - getLocation
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocation(org.djunits.value.vdouble.scalar.Length.Rel position)
                                                                  throws NetworkException
```
    Get the location at a position on the line, with its direction. Position should be between 0.0 and line length.
    
    Parameters:
    
    position - the position on the line for which to calculate the point on the line
    
    Returns:
    
    a directed point
    
    Throws:
    
    NetworkException - when position less than 0.0 or more than line length.
  - getLocationSI
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationSI(double positionSI)
                                                                    throws NetworkException
```
    Get the location at a position on the line, with its direction. Position should be between 0.0 and line length.
    
    Parameters:
    
    positionSI - the position on the line for which to calculate the point on the line
    
    Returns:
    
    a directed point
    
    Throws:
    
    NetworkException - when position less than 0.0 or more than line length.
  - getLocation
```
public nl.tudelft.simulation.language.d3.DirectedPoint getLocation()
```
    Specified by:
    
    getLocation in interface nl.tudelft.simulation.dsol.animation.LocatableInterface
  - getBounds
```
public javax.media.j3d.Bounds getBounds()
```
    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 OTSLine3D

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

Constructor Detail

OTSLine3D

OTSLine3D

OTSLine3D

OTSLine3D

OTSLine3D

Method Detail

getCoordinates

getLineString

size

get

getLengthSI

getLength

getPoints

getLocationExtended

getLocationExtendedSI

getLocationFraction

getLocation

getLocationSI

getLocation

getBounds

toString

hashCode

equals