Package org.opentrafficsim.core.geometry

Enum Class OtsLine2d.FractionalFallback

java.lang.Object

java.lang.Enum<OtsLine2d.FractionalFallback>

org.opentrafficsim.core.geometry.OtsLine2d.FractionalFallback

All Implemented Interfaces:

Serializable, Comparable<OtsLine2d.FractionalFallback>, Constable

Enclosing class:

OtsLine2d

public static enum OtsLine2d.FractionalFallback
extends Enum<OtsLine2d.FractionalFallback>

Fallback method for when fractional projection fails as the point is beyond the line or from numerical limitations.

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENDPOINT	Distance to nearest end point.
NaN	NaN value.
ORTHOGONAL	Orthogonal projection.

Method Summary

Modifier and Type	Method	Description
(package private) abstract double	getFraction(OtsLine2d line, double x, double y)	Returns fraction for when fractional projection fails as the point is beyond the line or from numerical limitations.
static OtsLine2d.FractionalFallback	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OtsLine2d.FractionalFallback[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ORTHOGONAL

public static final OtsLine2d.FractionalFallback ORTHOGONAL

Orthogonal projection.

ENDPOINT

public static final OtsLine2d.FractionalFallback ENDPOINT

Distance to nearest end point.

NaN

public static final OtsLine2d.FractionalFallback NaN

NaN value.

Method Details

values

public static OtsLine2d.FractionalFallback[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OtsLine2d.FractionalFallback valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getFraction

abstract double getFraction(OtsLine2d line,
 double x,
 double y)

Returns fraction for when fractional projection fails as the point is beyond the line or from numerical limitations.

Parameters:

line - OtsLine2d; line

x - double; x coordinate of point

y - double; y coordinate of point

Returns:

double; fraction for when fractional projection fails