org.opentrafficsim.core.geometry

Class OTSLine3D

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

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

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

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.DoubleScalar.Rel<org.djunits.unit.LengthUnit>	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.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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.DoubleScalar.Rel<org.djunits.unit.LengthUnit> 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()
                                                            throws RemoteException

Specified by:

getLocation in interface nl.tudelft.simulation.dsol.animation.LocatableInterface

Throws:

RemoteException

getBounds

public javax.media.j3d.Bounds getBounds()
                                 throws RemoteException

Specified by:

getBounds in interface nl.tudelft.simulation.dsol.animation.LocatableInterface

Throws:

RemoteException

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