Package org.opentrafficsim.core.geometry

Record Class CurveFlattener

java.lang.Object

java.lang.Record

org.opentrafficsim.core.geometry.CurveFlattener

Record Components:

flattener - regular flattener

offsetFlattener - offset flattener

All Implemented Interfaces:

Flattener<Flattener2d,Curve2d,PolyLine2d,Point2d,Double>, Flattener2d, OffsetFlattener2d

public record CurveFlattener(Flattener2d flattener, OffsetFlattener2d offsetFlattener)
extends Record
implements Flattener2d, OffsetFlattener2d

Record combining a Flattener2d and OffsetFlattener2d.

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djutils.draw.curve.Flattener

Flattener.FlattableCurve<P extends Object,DIR extends Object>

Nested classes/interfaces inherited from interface org.djutils.draw.curve.Flattener2d

Flattener2d.MaxAngle, Flattener2d.MaxDeviation, Flattener2d.MaxDeviationAndAngle, Flattener2d.NumSegments

Nested classes/interfaces inherited from interface org.djutils.draw.curve.OffsetFlattener2d

OffsetFlattener2d.MaxAngle, OffsetFlattener2d.MaxDeviation, OffsetFlattener2d.MaxDeviationAndAngle, OffsetFlattener2d.NumSegments

Constructor Summary

Constructors

Constructor	Description
CurveFlattener(double maxDeviation)	Flattener based on maximum deviation.
CurveFlattener(double maxDeviation, double maxAngle)	Flattener based on maximum deviation and angle.
CurveFlattener(int numSegments)	Flattener based on number of segments.
CurveFlattener(Angle maxAngle)	Flattener based on maximum angle.
CurveFlattener(Flattener2d flattener, OffsetFlattener2d offsetFlattener)	Creates an instance of a CurveFlattener record class.

Method Summary

Modifier and Type	Method	Description
boolean	checkDirectionError(Double segmentDirection, Double curveDirectionAtStart, Double curveDirectionAtEnd, double maxDirectionDeviation)
boolean	checkLoopBack(Double prevDirection, Double nextDirection)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PolyLine2d	flatten(Curve2d curve)
PolyLine2d	flatten(OffsetCurve2d curve, ContinuousPiecewiseLinearFunction of)
Flattener2d	flattener()	Returns the value of the flattener record component.
final int	hashCode()	Returns a hash code value for this object.
OffsetFlattener2d	offsetFlattener()	Returns the value of the offsetFlattener record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djutils.draw.curve.Flattener

checkInflectionPoint, checkPositionError, loadKnot, loadKnots

Methods inherited from interface org.djutils.draw.curve.OffsetFlattener2d

loadKnot, loadKnots, makeFlattableCurve

Constructor Details

CurveFlattener

public CurveFlattener(int numSegments)

Flattener based on number of segments.

Parameters:

numSegments - number of segments

CurveFlattener

public CurveFlattener(double maxDeviation)

Flattener based on maximum deviation.

Parameters:

maxDeviation - maximum deviation

CurveFlattener

public CurveFlattener(Angle maxAngle)

Flattener based on maximum angle.

Parameters:

maxAngle - maximum angle

CurveFlattener

public CurveFlattener(double maxDeviation,
 double maxAngle)

Flattener based on maximum deviation and angle.

Parameters:

maxDeviation - maximum deviation

maxAngle - maximum angle

CurveFlattener

public CurveFlattener(Flattener2d flattener,
 OffsetFlattener2d offsetFlattener)

Creates an instance of a CurveFlattener record class.

Parameters:

flattener - the value for the flattener record component

offsetFlattener - the value for the offsetFlattener record component

Method Details

flatten

public PolyLine2d flatten(Curve2d curve)

Specified by:

flatten in interface Flattener2d

flatten

public PolyLine2d flatten(OffsetCurve2d curve,
 ContinuousPiecewiseLinearFunction of)

Specified by:

flatten in interface OffsetFlattener2d

checkLoopBack

public boolean checkLoopBack(Double prevDirection,
 Double nextDirection)

Specified by:

checkLoopBack in interface Flattener<Flattener2d,Curve2d,PolyLine2d,Point2d,Double>

Specified by:

checkLoopBack in interface Flattener2d

Specified by:

checkLoopBack in interface OffsetFlattener2d

checkDirectionError

public boolean checkDirectionError(Double segmentDirection,
 Double curveDirectionAtStart,
 Double curveDirectionAtEnd,
 double maxDirectionDeviation)

Specified by:

checkDirectionError in interface Flattener<Flattener2d,Curve2d,PolyLine2d,Point2d,Double>

Specified by:

checkDirectionError in interface Flattener2d

Specified by:

checkDirectionError in interface OffsetFlattener2d

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.

flattener

public Flattener2d flattener()

Returns the value of the flattener record component.

Returns:

the value of the flattener record component

offsetFlattener

public OffsetFlattener2d offsetFlattener()

Returns the value of the offsetFlattener record component.

Returns:

the value of the offsetFlattener record component