org.opentrafficsim.core.geometry

Enum OTSLine3D.FractionalFallback

java.lang.Object

java.lang.Enum<OTSLine3D.FractionalFallback>

org.opentrafficsim.core.geometry.OTSLine3D.FractionalFallback

All Implemented Interfaces:

Serializable, Comparable<OTSLine3D.FractionalFallback>

Enclosing class:

OTSLine3D

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

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

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

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 18 apr. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Enum Constant Summary

Enum Constants

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

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ORTHOGONAL

public static final OTSLine3D.FractionalFallback ORTHOGONAL

Orthogonal projection.

ENDPOINT

public static final OTSLine3D.FractionalFallback ENDPOINT

Distance to nearest end point.

NaN

public static final OTSLine3D.FractionalFallback NaN

NaN value.

Method Detail

values

public static OTSLine3D.FractionalFallback[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OTSLine3D.FractionalFallback c : OTSLine3D.FractionalFallback.values())
    System.out.println(c);

Returns:

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

valueOf

public static OTSLine3D.FractionalFallback valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getFraction

abstract double getFraction(OTSLine3D 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 - OTSLine3D; line

x - double; x coordinate of point

y - double; y coordinate of point

Returns:

double; fraction for when fractional projection fails