org.opentrafficsim.road.network.lane

Class CrossSectionElement

java.lang.Object

org.opentrafficsim.road.network.lane.CrossSectionElement

All Implemented Interfaces:

Serializable, 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, 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-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, @version $Revision: 1401 $, by $Author: averbraeck $, initial version Aug 19, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.djunits.value.vdouble.scalar.Length.Rel	beginWidth Start width, positioned symmetrically around the lateral start position.
protected org.djunits.value.vdouble.scalar.Length.Rel	designLineOffsetAtBegin The lateral offset from the design line of the parentLink at the start of the parentLink.
protected org.djunits.value.vdouble.scalar.Length.Rel	designLineOffsetAtEnd The lateral offset from the design line of the parentLink at the end of the parentLink.
protected org.djunits.value.vdouble.scalar.Length.Rel	endWidth End width, positioned symmetrically around the lateral end position.
protected org.djunits.value.vdouble.scalar.Length.Rel	length The length of the line.
protected CrossSectionLink	parentLink Cross Section Link to which the element belongs.

Constructor Summary

Constructors

Constructor and Description

CrossSectionElement(CrossSectionLink parentLink, String id, org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtBegin, org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtEnd, org.djunits.value.vdouble.scalar.Length.Rel beginWidth, org.djunits.value.vdouble.scalar.Length.Rel 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

Modifier and Type	Method and Description
static org.opentrafficsim.core.geometry.OTSLine3D	constructContour(CrossSectionElement cse) Construct a buffer geometry by offsetting the linear geometry line with a distance and constructing a so-called "buffer" around it.
boolean	equals(Object obj)
org.djunits.value.vdouble.scalar.Length.Rel	getBeginWidth()
javax.media.j3d.Bounds	getBounds()
org.opentrafficsim.core.geometry.OTSLine3D	getCenterLine()
org.opentrafficsim.core.geometry.OTSLine3D	getContour()
org.djunits.value.vdouble.scalar.Length.Rel	getDesignLineOffsetAtBegin()
org.djunits.value.vdouble.scalar.Length.Rel	getDesignLineOffsetAtEnd()
org.djunits.value.vdouble.scalar.Length.Rel	getEndWidth()
String	getId()
org.djunits.value.vdouble.scalar.Length.Rel	getLateralBoundaryPosition(org.opentrafficsim.core.network.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.
org.djunits.value.vdouble.scalar.Length.Rel	getLateralBoundaryPosition(org.opentrafficsim.core.network.LateralDirectionality lateralDirection, org.djunits.value.vdouble.scalar.Length.Rel 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.
org.djunits.value.vdouble.scalar.Length.Rel	getLateralCenterPosition(double fractionalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
org.djunits.value.vdouble.scalar.Length.Rel	getLateralCenterPosition(org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition) Retrieve the lateral offset from the Link design line at the specified longitudinal position.
org.djunits.value.vdouble.scalar.Length.Rel	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()
org.djunits.value.vdouble.scalar.Length.Rel	getWidth(double fractionalPosition) Return the width of this CrossSectionElement at a specified fractional longitudinal position.
org.djunits.value.vdouble.scalar.Length.Rel	getWidth(org.djunits.value.vdouble.scalar.Length.Rel longitudinalPosition) Return the width of this CrossSectionElement at a specified longitudinal position.
protected abstract double	getZ()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parentLink

protected final CrossSectionLink parentLink

Cross Section Link to which the element belongs.

designLineOffsetAtBegin

protected final org.djunits.value.vdouble.scalar.Length.Rel designLineOffsetAtBegin

The lateral offset from the design line of the parentLink at the start of the parentLink.

designLineOffsetAtEnd

protected final org.djunits.value.vdouble.scalar.Length.Rel designLineOffsetAtEnd

The lateral offset from the design line of the parentLink at the end of the parentLink.

beginWidth

protected final org.djunits.value.vdouble.scalar.Length.Rel beginWidth

Start width, positioned symmetrically around the lateral start position.

endWidth

protected final org.djunits.value.vdouble.scalar.Length.Rel endWidth

End width, positioned symmetrically around the lateral end position.

length

protected final org.djunits.value.vdouble.scalar.Length.Rel length

The length of the line. Calculated once at the creation.

Constructor Detail

CrossSectionElement

public CrossSectionElement(CrossSectionLink parentLink,
                           String id,
                           org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtBegin,
                           org.djunits.value.vdouble.scalar.Length.Rel lateralOffsetAtEnd,
                           org.djunits.value.vdouble.scalar.Length.Rel beginWidth,
                           org.djunits.value.vdouble.scalar.Length.Rel endWidth)
                    throws org.opentrafficsim.core.geometry.OTSGeometryException,
                           org.opentrafficsim.core.network.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:

id - String; The id of the CrosssSectionElement. Should be unique within the parentLink.

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:

org.opentrafficsim.core.geometry.OTSGeometryException - when creation of the geometry fails

org.opentrafficsim.core.network.NetworkException - when id equal to null or not unique

Method Detail

getParentLink

public final CrossSectionLink getParentLink()

Returns:

parentLink.

getLateralCenterPosition

public final org.djunits.value.vdouble.scalar.Length.Rel 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 org.djunits.value.vdouble.scalar.Length.Rel getLateralCenterPosition(org.djunits.value.vdouble.scalar.Length.Rel 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 org.djunits.value.vdouble.scalar.Length.Rel getWidth(org.djunits.value.vdouble.scalar.Length.Rel 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 org.djunits.value.vdouble.scalar.Length.Rel 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.

getLength

public final org.djunits.value.vdouble.scalar.Length.Rel 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

getDesignLineOffsetAtBegin

public final org.djunits.value.vdouble.scalar.Length.Rel getDesignLineOffsetAtBegin()

Returns:

designLineOffsetAtBegin.

getDesignLineOffsetAtEnd

public final org.djunits.value.vdouble.scalar.Length.Rel getDesignLineOffsetAtEnd()

Returns:

designLineOffsetAtEnd.

getBeginWidth

public final org.djunits.value.vdouble.scalar.Length.Rel getBeginWidth()

Returns:

beginWidth.

getEndWidth

public final org.djunits.value.vdouble.scalar.Length.Rel getEndWidth()

Returns:

endWidth.

getZ

protected abstract double getZ()

Returns:

the z-offset for drawing (what's on top, what's underneath).

getCenterLine

public final org.opentrafficsim.core.geometry.OTSLine3D getCenterLine()

Returns:

centerLine.

getContour

public final org.opentrafficsim.core.geometry.OTSLine3D getContour()

Returns:

contour.

getId

public final String getId()

Returns:

id

getLateralBoundaryPosition

public final org.djunits.value.vdouble.scalar.Length.Rel getLateralBoundaryPosition(org.opentrafficsim.core.network.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 org.djunits.value.vdouble.scalar.Length.Rel getLateralBoundaryPosition(org.opentrafficsim.core.network.LateralDirectionality lateralDirection,
                                                                                    org.djunits.value.vdouble.scalar.Length.Rel 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>

constructContour

public static org.opentrafficsim.core.geometry.OTSLine3D constructContour(CrossSectionElement cse)
                                                                   throws org.opentrafficsim.core.geometry.OTSGeometryException,
                                                                          org.opentrafficsim.core.network.NetworkException

Construct a buffer geometry by offsetting the linear geometry line with a distance and constructing a so-called "buffer" around it.

Parameters:

cse - the CrossSectionElement to construct the contour for

Returns:

the geometry belonging to this CrossSectionElement.

Throws:

org.opentrafficsim.core.geometry.OTSGeometryException - when construction of the geometry fails

org.opentrafficsim.core.network.NetworkException - when the resulting contour is degenerate (cannot happen; we hope)

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