org.opentrafficsim.core.network.lane

Class CrossSectionElement

java.lang.Object

org.opentrafficsim.core.network.lane.CrossSectionElement

All Implemented Interfaces:

nl.tudelft.simulation.dsol.animation.LocatableInterface

Direct Known Subclasses:

Lane, RoadMarkerAlong, Shoulder

public abstract class CrossSectionElement
extends Object
implements nl.tudelft.simulation.dsol.animation.LocatableInterface

Copyright (c) 2013-2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

Constructor Summary

Constructors

Constructor and Description

CrossSectionElement(CrossSectionLink<?,?> parentLink, DoubleScalar.Rel<LengthUnit> lateralOffsetAtBegin, DoubleScalar.Rel<LengthUnit> lateralOffsetAtEnd, DoubleScalar.Rel<LengthUnit> beginWidth, DoubleScalar.Rel<LengthUnit> endWidth) Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.

Method Summary

Methods

Modifier and Type	Method and Description
javax.media.j3d.Bounds	getBounds()
com.vividsolutions.jts.geom.LineString	getCenterLine() Retrieve the center line or design line of this CrossSectionElement.
com.vividsolutions.jts.geom.Geometry	getContour()
DoubleScalar.Rel<LengthUnit>	getLateralBoundaryPosition(LateralDirectionality lateralDirection, double fractionalLongitudinalPosition) Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified fractional longitudinal position.
DoubleScalar.Rel<LengthUnit>	getLateralBoundaryPosition(LateralDirectionality lateralDirection, DoubleScalar.Rel<LengthUnit> longitudinalPosition) Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified longitudinal position.
DoubleScalar.Rel<LengthUnit>	getLateralCenterPosition(double fractionalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
DoubleScalar<LengthUnit>	getLateralCenterPosition(DoubleScalar.Rel<LengthUnit> longitudinalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
DoubleScalar.Rel<LengthUnit>	getLength() Return the length of this CrossSectionElement as measured along the design line (which equals the center line).
nl.tudelft.simulation.language.d3.DirectedPoint	getLocation()
CrossSectionLink<?,?>	getParentLink()
DoubleScalar.Rel<LengthUnit>	getWidth(double fractionalPosition) Return the width of this CrossSectionElement at a specified fractional longitudinal position.
DoubleScalar.Rel<LengthUnit>	getWidth(DoubleScalar.Rel<LengthUnit> longitudinalPosition) Return the width of this CrossSectionElement at a specified longitudinal position.
protected abstract double	getZ()
static void	printCoordinate(String prefix, com.vividsolutions.jts.geom.Coordinate coordinate) Print one Coordinate on the console.
static void	printCoordinates(String prefix, com.vividsolutions.jts.geom.Coordinate[] coordinates) Print an array of coordinates on the console.
static void	printCoordinates(String prefix, com.vividsolutions.jts.geom.Coordinate[] coordinates, int fromIndex, int toIndex) Print part of an array of coordinates on the console.
static void	printCoordinates(String prefix, com.vividsolutions.jts.geom.Geometry geometry) Print coordinates of a Geometry on the console.
static void	printCoordinates(String prefix, com.vividsolutions.jts.geom.Geometry geometry, int fromIndex, int toIndex) Print coordinates of a Geometry on the console.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CrossSectionElement

public CrossSectionElement(CrossSectionLink<?,?> parentLink,
                   DoubleScalar.Rel<LengthUnit> lateralOffsetAtBegin,
                   DoubleScalar.Rel<LengthUnit> lateralOffsetAtEnd,
                   DoubleScalar.Rel<LengthUnit> beginWidth,
                   DoubleScalar.Rel<LengthUnit> endWidth)
                    throws NetworkException

Note: LEFT is seen as a positive lateral direction, RIGHT as a negative lateral direction, with the direction from the StartNode towards the EndNode as the longitudinal direction.

Parameters:

parentLink - CrossSectionLink; Link to which the element belongs.

lateralOffsetAtBegin - DoubleScalar.Rel<LengthUnit>; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the start of the parent Link

lateralOffsetAtEnd - DoubleScalar.Rel<LengthUnit>; the lateral offset of the design line of the new CrossSectionLink with respect to the design line of the parent Link at the end of the parent Link

beginWidth - DoubleScalar.Rel<LengthUnit>; width at start, positioned symmetrically around the design line

endWidth - DoubleScalar.Rel<LengthUnit>; width at end, positioned symmetrically around the design line

Throws:

NetworkException - when creation of the geometry fails

Method Detail

getParentLink

public final CrossSectionLink<?,?> getParentLink()

Returns:

parentLink.

getLateralCenterPosition

public final DoubleScalar.Rel<LengthUnit> getLateralCenterPosition(double fractionalPosition)

Retrieve the lateral offset from the Link design line at the specified longitudinal position.

Parameters:

fractionalPosition - double; fractional longitudinal position on this Lane

Returns:

DoubleScalar.Rel<LengthUnit> the lateralCenterPosition at the specified longitudinal position

getLateralCenterPosition

public final DoubleScalar<LengthUnit> getLateralCenterPosition(DoubleScalar.Rel<LengthUnit> longitudinalPosition)

Retrieve the lateral offset from the Link design line at the specified longitudinal position.

Parameters:

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the longitudinal position on this Lane

Returns:

DoubleScalar.Rel<LengthUnit> the lateralCenterPosition at the specified longitudinal position

getWidth

public final DoubleScalar.Rel<LengthUnit> getWidth(DoubleScalar.Rel<LengthUnit> longitudinalPosition)

Return the width of this CrossSectionElement at a specified longitudinal position.

Parameters:

longitudinalPosition - DoubleScalar<LengthUnit>; the longitudinal position

Returns:

DoubleScalar.Rel<LengthUnit>; the width of this CrossSectionElement at the specified longitudinal position.

getWidth

public final DoubleScalar.Rel<LengthUnit> getWidth(double fractionalPosition)

Return the width of this CrossSectionElement at a specified fractional longitudinal position.

Parameters:

fractionalPosition - double; the fractional longitudinal position

Returns:

DoubleScalar.Rel<LengthUnit>; the width of this CrossSectionElement at the specified fractional longitudinal position.

getZ

protected abstract double getZ()

Returns:

the z-value to determine "stacking" for animation.

getLocation

public final nl.tudelft.simulation.language.d3.DirectedPoint getLocation()
                                                                  throws RemoteException

Specified by:

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

Throws:

RemoteException

getBounds

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

Specified by:

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

Throws:

RemoteException

getContour

public final com.vividsolutions.jts.geom.Geometry getContour()

Returns:

the contour of this CrossSectionElement.
Do not modify the returned object or chaos will ensue.

getCenterLine

public final com.vividsolutions.jts.geom.LineString getCenterLine()

Retrieve the center line or design line of this CrossSectionElement.
Do not modify the returned object or chaos will ensue.

Returns:

LineString; the design line of this CrossSectionElement (which equals the center line of this CrossSectionElement)

printCoordinate

public static void printCoordinate(String prefix,
                   com.vividsolutions.jts.geom.Coordinate coordinate)

Print one Coordinate on the console.

Parameters:

prefix - String; text to put before the output

coordinate - Coordinate; the coordinate to print

printCoordinates

public static void printCoordinates(String prefix,
                    com.vividsolutions.jts.geom.Geometry geometry,
                    int fromIndex,
                    int toIndex)

Print coordinates of a Geometry on the console.

Parameters:

prefix - String; text to put before the output

geometry - Geometry; the coordinates to print

fromIndex - int; index of the first coordinate to print

toIndex - int; one higher than the index of the last coordinate to print

printCoordinates

public static void printCoordinates(String prefix,
                    com.vividsolutions.jts.geom.Geometry geometry)

Print coordinates of a Geometry on the console.

Parameters:

prefix - String; text to put before the output

geometry - Geometry; the coordinates to print

printCoordinates

public static void printCoordinates(String prefix,
                    com.vividsolutions.jts.geom.Coordinate[] coordinates)

Print an array of coordinates on the console.

Parameters:

prefix - String; text to put before the coordinates

coordinates - Coordinate[]; the coordinates to print

printCoordinates

public static void printCoordinates(String prefix,
                    com.vividsolutions.jts.geom.Coordinate[] coordinates,
                    int fromIndex,
                    int toIndex)

Print part of an array of coordinates on the console.

Parameters:

prefix - String; text to put before the output

coordinates - Coordinate[]; the coordinates to print

fromIndex - int; index of the first coordinate to print

toIndex - int; one higher than the index of the last coordinate to print

getLength

public final DoubleScalar.Rel<LengthUnit> getLength()

Return the length of this CrossSectionElement as measured along the design line (which equals the center line).

Returns:

DoubleScalar.Rel<LengthUnit>; the length of this CrossSectionElement

toString

public String toString()

Overrides:

toString in class Object

getLateralBoundaryPosition

public final DoubleScalar.Rel<LengthUnit> getLateralBoundaryPosition(LateralDirectionality lateralDirection,
                                                      double fractionalLongitudinalPosition)

Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified fractional longitudinal position.

Parameters:

lateralDirection - LateralDirectionality; LEFT, or RIGHT

fractionalLongitudinalPosition - double; ranges from 0.0 (begin of parentLink) to 1.0 (end of parentLink)

Returns:

DoubleScalar.Rel<LengthUnit>

getLateralBoundaryPosition

public final DoubleScalar.Rel<LengthUnit> getLateralBoundaryPosition(LateralDirectionality lateralDirection,
                                                      DoubleScalar.Rel<LengthUnit> longitudinalPosition)

Return the lateral offset from the design line of the parent Link of the Left or Right boundary of this CrossSectionElement at the specified longitudinal position.

Parameters:

lateralDirection - LateralDirectionality; LEFT, or RIGHT

longitudinalPosition - DoubleScalar.Rel<LengthUnit>; the position along the length of this CrossSectionElement

Returns:

DoubleScalar.Rel<LengthUnit>