OTSLine3D (Open Traffic Sim core classes 0.05.00-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, nl.tudelft.simulation.dsol.animation.LocatableInterface

Direct Known Subclasses:

OTSPolygon3D
```
public class OTSLine3D
extends Object
implements nl.tudelft.simulation.dsol.animation.LocatableInterface, Serializable
```
Line with OTSPoint3D points, a cached length indexed line, a cahced length, and a cached centroid (all calculated on first use).
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
Modifier and Type Class and Description

static class OTSLine3D.OffsetMethod
Which offsetLine method to use...

Nested Classes
Modifier and Type	Class and Description
`static class`	`OTSLine3D.OffsetMethod` Which offsetLine method to use...

Field Summary

Fields
Modifier and Type Field and Description

static OTSLine3D.OffsetMethod OFFSETMETHOD
Which offset line method to use...

Fields
Modifier and Type	Field and Description
`static OTSLine3D.OffsetMethod`	`OFFSETMETHOD` Which offset line method to use...

Constructor Summary

Constructors
Constructor and Description
`OTSLine3D(com.vividsolutions.jts.geom.Coordinate[] coordinates)` Construct a new OTSLine3D from an array of Coordinate.
`OTSLine3D(com.vividsolutions.jts.geom.Geometry geometry)` Construct a new OTSLine3D from a Geometry.
`OTSLine3D(com.vividsolutions.jts.geom.LineString lineString)` Construct a new OTSLine3D from a LineString.
`OTSLine3D(List<OTSPoint3D> pointList)` Construct a new OTSLine3D from a List<OTSPoint3D>.
`OTSLine3D(OTSPoint3D... points)` Construct a new OTSLine3D.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OTSLine3D`	`concatenate(double toleranceSI, OTSLine3D... lines)` Concatenate several OTSLine3D instances.
`static OTSLine3D`	`concatenate(OTSLine3D... lines)` Concatenate several OTSLine3D instances.
`static OTSLine3D`	`createAndCleanOTSLine3D(List<OTSPoint3D> pointList)` Create an OTSLine3D, while cleaning repeating successive points.
`static OTSLine3D`	`createAndCleanOTSLine3D(OTSPoint3D[] points)` Create an OTSLine3D, while cleaning repeating successive points.
`boolean`	`equals(Object obj)`
`OTSLine3D`	`extract(double start, double end)` Create a new OTSLine3D that covers a sub-section of this OTSLine3D.
`OTSLine3D`	`extract(org.djunits.value.vdouble.scalar.Length.Rel start, org.djunits.value.vdouble.scalar.Length.Rel end)` Create a new OTSLine3D that covers a sub-section of this OTSLine3D.
`OTSLine3D`	`extractFractional(double start, double end)` Construct a new OTSLine3D covering the indicated fraction of this OTSLine3D.
`OTSPoint3D`	`get(int i)` Return one point of this OTSLine3D.
`javax.media.j3d.Bounds`	`getBounds()`
`com.vividsolutions.jts.geom.Coordinate[]`	`getCoordinates()` Construct a Coordinate array and fill it with the points of this OTSLine3D.
`OTSPoint3D`	`getFirst()` Return the first point of this OTSLine3D.
`OTSPoint3D`	`getLast()` Return the last point of this OTSLine3D.
`org.djunits.value.vdouble.scalar.Length.Rel`	`getLength()` Return the length of this OTSLine3D in meters.
`double`	`getLengthSI()` Return the length of this OTSLine3D as a double value in SI units.
`com.vividsolutions.jts.geom.LineString`	`getLineString()` Construct a LineString from this OTSLine3D.
`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`	`getLocationFraction(double fraction, double tolerance)` Get the location at a fraction of the line, with its direction.
`nl.tudelft.simulation.language.d3.DirectedPoint`	`getLocationFractionExtended(double fraction)` Get the location at a fraction of the line (or outside 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()` Return an array of OTSPoint3D that represents this OTSLine3D.
`int`	`hashCode()`
`static void`	`main(String[] args)`
`OTSLine3D`	`noiseFilteredLine(double noiseLevel)` Construct a line that is equal to this line except for segments that are shorter than the noiseLevel.
`OTSLine3D`	`offsetLine(double offset)` Construct parallel line.
`OTSLine3D`	`offsetLine(double[] relativeFractions, double[] offsets)` Create a line at linearly varying offset from this line.
`OTSLine3D`	`offsetLine(double offsetAtStart, double offsetAtEnd)` Create a line at linearly varying offset from this line.
`OTSLine3D`	`reverse()` Construct a new OTSLine3D with all points of this OTSLine3D in reverse order.
`int`	`size()` Return the number of points in this OTSLine3D.
`String`	`toExcel()`
`String`	`toString()`
`OTSLine3D`	`truncate(double lengthSI)` Truncate a line at the given length (less than the length of the line, and larger than zero) and return a new line.

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

- Field Detail
  - OFFSETMETHOD
```
public static final OTSLine3D.OffsetMethod OFFSETMETHOD
```
    Which offset line method to use...
- Constructor Detail
  - OTSLine3D
```
public OTSLine3D(OTSPoint3D... points)
          throws OTSGeometryException
```
    Construct a new OTSLine3D.
    
    Parameters:
    
    points - the array of points to construct this OTSLine3D from.
    
    Throws:
    
    OTSGeometryException - when the provided points do not constitute a valid line (too few points or identical adjacent points)
  - OTSLine3D
```
public OTSLine3D(com.vividsolutions.jts.geom.Coordinate[] coordinates)
          throws OTSGeometryException
```
    Construct a new OTSLine3D from an array of Coordinate.
    
    Parameters:
    
    coordinates - the array of coordinates to construct this OTSLine3D from
    
    Throws:
    
    OTSGeometryException - when the provided points do not constitute a valid line (too few points or identical adjacent points)
  - OTSLine3D
```
public OTSLine3D(com.vividsolutions.jts.geom.LineString lineString)
          throws OTSGeometryException
```
    Construct a new OTSLine3D from a LineString.
    
    Parameters:
    
    lineString - the lineString to construct this OTSLine3D from.
    
    Throws:
    
    OTSGeometryException - when the provided LineString does not constitute a valid line (too few points or identical adjacent points)
  - OTSLine3D
```
public OTSLine3D(com.vividsolutions.jts.geom.Geometry geometry)
          throws OTSGeometryException
```
    Construct a new OTSLine3D from a Geometry.
    
    Parameters:
    
    geometry - the geometry to construct this OTSLine3D from
    
    Throws:
    
    OTSGeometryException - when the provided Geometry do not constitute a valid line (too few points or identical adjacent points)
  - OTSLine3D
```
public OTSLine3D(List<OTSPoint3D> pointList)
          throws OTSGeometryException
```
    Construct a new OTSLine3D from a List<OTSPoint3D>.
    
    Parameters:
    
    pointList - the list of points to construct this OTSLine3D from.
    
    Throws:
    
    OTSGeometryException - when the provided points do not constitute a valid line (too few points or identical adjacent points)
- Method Detail
  - offsetLine
```
public final OTSLine3D offsetLine(double offset)
```
    Construct parallel line.
    
    Parameters:
    
    offset - double; offset distance from the reference line; positive is LEFT, negative is RIGHT
    
    Returns:
    
    OTSLine3D; the line that has the specified offset from the reference line
  - noiseFilteredLine
```
public final OTSLine3D noiseFilteredLine(double noiseLevel)
```
    Construct a line that is equal to this line except for segments that are shorter than the noiseLevel. The result is guaranteed to start with the first point of this line and end with the last point of this line.
    
    Parameters:
    
    noiseLevel - double; the minimum segment length that is not removed
    
    Returns:
    
    OTSLine3D; the filtered line
  - offsetLine
```
public final OTSLine3D offsetLine(double offsetAtStart,
                                  double offsetAtEnd)
                           throws OTSGeometryException
```
    Create a line at linearly varying offset from this line. The offset may change linearly from its initial value at the start of the reference line to its final offset value at the end of the reference line.
    
    Parameters:
    
    offsetAtStart - double; offset at the start of the reference line (positive value is Left, negative value is Right)
    
    offsetAtEnd - double; offset at the end of the reference line (positive value is Left, negative value is Right)
    
    Returns:
    
    Geometry; the Geometry of the line at linearly changing offset of the reference line
    
    Throws:
    
    OTSGeometryException - when this method fails to create the offset line
  - offsetLine
```
public final OTSLine3D offsetLine(double[] relativeFractions,
                                  double[] offsets)
                           throws OTSGeometryException
```
    Create a line at linearly varying offset from this line. The offset may change linearly from its initial value at the start of the reference line via a number of intermediate offsets at intermediate positions to its final offset value at the end of the reference line.
    
    Parameters:
    
    relativeFractions - double[]; positional fractions for which the offsets have to be generated
    
    offsets - double[]; offsets at the relative positions (positive value is Left, negative value is Right)
    
    Returns:
    
    Geometry; the Geometry of the line at linearly changing offset of the reference line
    
    Throws:
    
    OTSGeometryException - when this method fails to create the offset line
  - concatenate
```
public static OTSLine3D concatenate(OTSLine3D... lines)
                             throws OTSGeometryException
```
    Concatenate several OTSLine3D instances.
    
    Parameters:
    
    lines - OTSLine3D... one or more OTSLine3D. The last point of the first must match the first of the second, etc.
    
    Returns:
    
    OTSLine3D
    
    Throws:
    
    OTSGeometryException - if zero lines are given, or when there is a gap between consecutive lines
  - concatenate
```
public static OTSLine3D concatenate(double toleranceSI,
                                    OTSLine3D... lines)
                             throws OTSGeometryException
```
    Concatenate several OTSLine3D instances.
    
    Parameters:
    
    toleranceSI - the tolerance between the end point of a line and the first point of the next line
    
    lines - OTSLine3D... one or more OTSLine3D. The last point of the first must match the first of the second, etc.
    
    Returns:
    
    OTSLine3D
    
    Throws:
    
    OTSGeometryException - if zero lines are given, or when there is a gap between consecutive lines
  - reverse
```
public final OTSLine3D reverse()
```
    Construct a new OTSLine3D with all points of this OTSLine3D in reverse order.
    
    Returns:
    
    OTSLine3D; the new OTSLine3D
  - extractFractional
```
public final OTSLine3D extractFractional(double start,
                                         double end)
                                  throws OTSGeometryException
```
    Construct a new OTSLine3D covering the indicated fraction of this OTSLine3D.
    
    Parameters:
    
    start - double; starting point, valid range [0..end)
    
    end - double; ending point, valid range (start..1]
    
    Returns:
    
    OTSLine3D; the new OTSLine3D
    
    Throws:
    
    OTSGeometryException - when start >= end, or start < 0, or end > 1
  - extract
```
public final OTSLine3D extract(org.djunits.value.vdouble.scalar.Length.Rel start,
                               org.djunits.value.vdouble.scalar.Length.Rel end)
                        throws OTSGeometryException
```
    Create a new OTSLine3D that covers a sub-section of this OTSLine3D.
    
    Parameters:
    
    start - Length.Rel; the length along this OTSLine3D where the sub-section starts, valid range [0..end)
    
    end - Length.Rel; length along this OTSLine3D where the sub-section ends, valid range (start..length (length is the length of this OTSLine3D)
    
    Returns:
    
    OTSLine3D; the selected sub-section
    
    Throws:
    
    OTSGeometryException - when start >= end, or start < 0, or end > length
  - extract
```
public final OTSLine3D extract(double start,
                               double end)
                        throws OTSGeometryException
```
    Create a new OTSLine3D that covers a sub-section of this OTSLine3D.
    
    Parameters:
    
    start - double; length along this OTSLine3D where the sub-section starts, valid range [0..end)
    
    end - double; length along this OTSLine3D where the sub-section ends, valid range (start..length (length is the length of this OTSLine3D)
    
    Returns:
    
    OTSLine3D; the selected sub-section
    
    Throws:
    
    OTSGeometryException - when start >= end, or start < 0, or end > length
  - createAndCleanOTSLine3D
```
public static OTSLine3D createAndCleanOTSLine3D(OTSPoint3D[] points)
                                         throws OTSGeometryException
```
    Create an OTSLine3D, while cleaning repeating successive points.
    
    Parameters:
    
    points - the coordinates of the line as OTSPoint3D
    
    Returns:
    
    the line
    
    Throws:
    
    OTSGeometryException - when number of points < 2
  - createAndCleanOTSLine3D
```
public static OTSLine3D createAndCleanOTSLine3D(List<OTSPoint3D> pointList)
                                         throws OTSGeometryException
```
    Create an OTSLine3D, while cleaning repeating successive points.
    
    Parameters:
    
    pointList - List<OTSPoint3D>; list of the coordinates of the line as OTSPoint3D; any duplicate points in this list are removed (this method may modify the provided list)
    
    Returns:
    
    OTSLine3D; the line
    
    Throws:
    
    OTSGeometryException - when number of non-equal points < 2
  - getCoordinates
```
public final com.vividsolutions.jts.geom.Coordinate[] getCoordinates()
```
    Construct a Coordinate array and fill it with the points of this OTSLine3D.
    
    Returns:
    
    an array of Coordinates corresponding to this OTSLine
  - getLineString
```
public final com.vividsolutions.jts.geom.LineString getLineString()
```
    Construct a LineString from this OTSLine3D.
    
    Returns:
    
    a LineString corresponding to this OTSLine
  - size
```
public final int size()
```
    Return the number of points in this OTSLine3D.
    
    Returns:
    
    the number of points on the line
  - getFirst
```
public final OTSPoint3D getFirst()
```
    Return the first point of this OTSLine3D.
    
    Returns:
    
    the first point on the line
  - getLast
```
public final OTSPoint3D getLast()
```
    Return the last point of this OTSLine3D.
    
    Returns:
    
    the last point on the line
  - get
```
public final OTSPoint3D get(int i)
                     throws OTSGeometryException
```
    Return one point of this OTSLine3D.
    
    Parameters:
    
    i - int; the index of the point to retrieve
    
    Returns:
    
    OTSPoint3d; the i-th point of the line
    
    Throws:
    
    OTSGeometryException - when i < 0 or i > the number of points
  - getLengthSI
```
public final double getLengthSI()
```
    Return the length of this OTSLine3D as a double value in SI units. (Assumes that the coordinates of the points constituting this line are expressed in meters.)
    
    Returns:
    
    the length of the line in SI units
  - getLength
```
public final org.djunits.value.vdouble.scalar.Length.Rel getLength()
```
    Return the length of this OTSLine3D in meters. (Assuming that the coordinates of the points constituting this line are expressed in meters.)
    
    Returns:
    
    the length of the line
  - getPoints
```
public final OTSPoint3D[] getPoints()
```
    Return an array of OTSPoint3D that represents this OTSLine3D. Do not modify the result.
    
    Returns:
    
    the points of this line
  - getLocationExtended
```
public final 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. 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
  - getLocationExtendedSI
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationExtendedSI(double positionSI)
```
    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
  - getLocationFraction
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationFraction(double fraction)
                                                                          throws OTSGeometryException
```
    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:
    
    OTSGeometryException - when fraction less than 0.0 or more than 1.0.
  - getLocationFraction
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationFraction(double fraction,
                                                                                 double tolerance)
                                                                          throws OTSGeometryException
```
    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
    
    tolerance - the delta from 0.0 and 1.0 that will be forgiven
    
    Returns:
    
    a directed point
    
    Throws:
    
    OTSGeometryException - when fraction less than 0.0 or more than 1.0.
  - getLocationFractionExtended
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationFractionExtended(double fraction)
```
    Get the location at a fraction of the line (or outside the line), with its direction.
    
    Parameters:
    
    fraction - the fraction for which to calculate the point on the line
    
    Returns:
    
    a directed point
  - getLocation
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocation(org.djunits.value.vdouble.scalar.Length.Rel position)
                                                                  throws OTSGeometryException
```
    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:
    
    OTSGeometryException - when position less than 0.0 or more than line length.
  - getLocationSI
```
public final nl.tudelft.simulation.language.d3.DirectedPoint getLocationSI(double positionSI)
                                                                    throws OTSGeometryException
```
    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:
    
    OTSGeometryException - when position less than 0.0 or more than line length.
  - truncate
```
public final OTSLine3D truncate(double lengthSI)
                         throws OTSGeometryException
```
    Truncate a line at the given length (less than the length of the line, and larger than zero) and return a new line.
    
    Parameters:
    
    lengthSI - the location where to truncate the line
    
    Returns:
    
    a new OTSLine3D truncated at the exact position where line.getLength() == lengthSI
    
    Throws:
    
    OTSGeometryException - 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
  - toExcel
```
public final String toExcel()
```
    Returns:
    
    excel XY plottable output
  - main
```
public static void main(String[] args)
                 throws OTSGeometryException
```
    Parameters:
    
    args - String[]; the command line arguments (not used)
    
    Throws:
    
    OTSGeometryException - in case of error

Class OTSLine3D

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OFFSETMETHOD

Constructor Detail

OTSLine3D

OTSLine3D

OTSLine3D

OTSLine3D

OTSLine3D

Method Detail

offsetLine

noiseFilteredLine

offsetLine

offsetLine

concatenate

concatenate

reverse

extractFractional

extract

extract

createAndCleanOTSLine3D

createAndCleanOTSLine3D

getCoordinates

getLineString

size

getFirst

getLast

get

getLengthSI

getLength

getPoints

getLocationExtended

getLocationExtendedSI

getLocationFraction

getLocationFraction

getLocationFractionExtended

getLocation

getLocationSI

truncate

getLocation

getBounds

toString

hashCode

equals

toExcel

main