org.apache.commons.geometry.spherical.oned

Class CutAngles

java.lang.Object

org.apache.commons.geometry.spherical.oned.CutAngles

public final class CutAngles
extends Object

Class containing factory methods for constructing CutAngle instances.

Method Summary

Modifier and Type	Method and Description
static CutAngle	createNegativeFacing(double azimuth, Precision.DoubleEquivalence precision) Create a new instance at the given azimuth, oriented so that the plus side of the hyperplane points toward decreasing angular values.
static CutAngle	createNegativeFacing(Point1S point, Precision.DoubleEquivalence precision) Create a new instance at the given point, oriented so that the plus side of the hyperplane points toward decreasing angular values.
static CutAngle	createPositiveFacing(double azimuth, Precision.DoubleEquivalence precision) Create a new instance at the given azimuth, oriented so that the plus side of the hyperplane points toward increasing angular values.
static CutAngle	createPositiveFacing(Point1S point, Precision.DoubleEquivalence precision) Create a new instance at the given point, oriented so that the plus side of the hyperplane points toward increasing angular values.
static CutAngle	fromAzimuthAndDirection(double azimuth, boolean positiveFacing, Precision.DoubleEquivalence precision) Create a new instance from the given azimuth and direction.
static CutAngle	fromPointAndDirection(Point1S point, boolean positiveFacing, Precision.DoubleEquivalence precision) Create a new instance from the given point and direction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromAzimuthAndDirection

public static CutAngle fromAzimuthAndDirection(double azimuth,
                                               boolean positiveFacing,
                                               Precision.DoubleEquivalence precision)

Create a new instance from the given azimuth and direction.

Parameters:

azimuth - azimuth value in radians

positiveFacing - if true, the instance's plus side will be oriented to point toward increasing angular values; if false, it will point toward decreasing angular value

precision - precision context used to determine floating point equality

Returns:

a new instance

fromPointAndDirection

public static CutAngle fromPointAndDirection(Point1S point,
                                             boolean positiveFacing,
                                             Precision.DoubleEquivalence precision)

Create a new instance from the given point and direction.

Parameters:

point - point representing the location of the hyperplane

positiveFacing - if true, the instance's plus side will be oriented to point toward increasing angular values; if false, it will point toward decreasing angular value

precision - precision context used to determine floating point equality

Returns:

a new instance

createPositiveFacing

public static CutAngle createPositiveFacing(double azimuth,
                                            Precision.DoubleEquivalence precision)

Create a new instance at the given azimuth, oriented so that the plus side of the hyperplane points toward increasing angular values.

Parameters:

azimuth - azimuth value in radians

precision - precision precision context used to determine floating point equality

Returns:

a new instance

createPositiveFacing

public static CutAngle createPositiveFacing(Point1S point,
                                            Precision.DoubleEquivalence precision)

Create a new instance at the given point, oriented so that the plus side of the hyperplane points toward increasing angular values.

Parameters:

point - point representing the location of the hyperplane

precision - precision precision context used to determine floating point equality

Returns:

a new instance

createNegativeFacing

public static CutAngle createNegativeFacing(double azimuth,
                                            Precision.DoubleEquivalence precision)

Create a new instance at the given azimuth, oriented so that the plus side of the hyperplane points toward decreasing angular values.

Parameters:

azimuth - azimuth value in radians

precision - precision precision context used to determine floating point equality

Returns:

a new instance

createNegativeFacing

public static CutAngle createNegativeFacing(Point1S point,
                                            Precision.DoubleEquivalence precision)

Create a new instance at the given point, oriented so that the plus side of the hyperplane points toward decreasing angular values.

Parameters:

point - point representing the location of the hyperplane

precision - precision precision context used to determine floating point equality

Returns:

a new instance