Package org.opentrafficsim.road.network.lane

Record Class CrossSectionGeometry

java.lang.Object

java.lang.Record

org.opentrafficsim.road.network.lane.CrossSectionGeometry

Record Components:

centerLine - center line

absoluteContour - contour

offset - offset

width - width

public record CrossSectionGeometry(OtsLine2d centerLine, Polygon2d absoluteContour, ContinuousPiecewiseLinearFunction offset, ContinuousPiecewiseLinearFunction width)
extends Record

Cross-section element geometry. A static method of(...) is available to generate geometry based on a design line and information on offset and width.

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

Author:

Wouter Schakel

Constructor Summary

Constructors

Constructor	Description
CrossSectionGeometry(OtsLine2d centerLine, Polygon2d absoluteContour, ContinuousPiecewiseLinearFunction offset, ContinuousPiecewiseLinearFunction width)	Constructor.

Method Summary

Modifier and Type	Method	Description
Polygon2d	absoluteContour()	Returns the value of the absoluteContour record component.
OtsLine2d	centerLine()	Returns the value of the centerLine record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
DirectedPoint2d	getLocation()	Returns the location.
Polygon2d	getRelativeContour()	Returns the relative contour.
final int	hashCode()	Returns a hash code value for this object.
static CrossSectionGeometry	of(OffsetCurve2d designLine, OffsetFlattener2d flattener, ContinuousPiecewiseLinearFunction offset, ContinuousPiecewiseLinearFunction width)	Create geometry based on design line, flattener, offset and width information.
ContinuousPiecewiseLinearFunction	offset()	Returns the value of the offset record component.
final String	toString()	Returns a string representation of this record class.
ContinuousPiecewiseLinearFunction	width()	Returns the value of the width record component.

Methods inherited from class java.lang.Object

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

Constructor Details

CrossSectionGeometry

public CrossSectionGeometry(OtsLine2d centerLine,
 Polygon2d absoluteContour,
 ContinuousPiecewiseLinearFunction offset,
 ContinuousPiecewiseLinearFunction width)

Constructor.

Throws:

NullPointerException - when centerLine, contour or slices is null

Method Details

of

public static CrossSectionGeometry of(OffsetCurve2d designLine,
 OffsetFlattener2d flattener,
 ContinuousPiecewiseLinearFunction offset,
 ContinuousPiecewiseLinearFunction width)

Create geometry based on design line, flattener, offset and width information.

Parameters:

designLine - design line relative to which offsets are defined

flattener - flattener to flatten center line and contour

offset - offset information

width - offset information

Returns:

geometry for cross-section element

getLocation

public DirectedPoint2d getLocation()

Returns the location.

Returns:

returns the location of this geometry

getRelativeContour

public Polygon2d getRelativeContour()

Returns the relative contour.

Returns:

relative contour

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

centerLine

public OtsLine2d centerLine()

Returns the value of the centerLine record component.

Returns:

the value of the centerLine record component

absoluteContour

public Polygon2d absoluteContour()

Returns the value of the absoluteContour record component.

Returns:

the value of the absoluteContour record component

offset

public ContinuousPiecewiseLinearFunction offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component

width

public ContinuousPiecewiseLinearFunction width()

Returns the value of the width record component.

Returns:

the value of the width record component