org.djunits.value

Interface AngleUtil

public interface AngleUtil

Utilities for Angles, such as normalization between 0 and 2 * PI.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 30, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
static Angle	normalize(Angle angle) Normalize an angle between 0 and 2 * PI.
static Direction	normalize(Direction angle) Normalize an angle between 0 and 2 * PI.
static double	normalize(double angle) Normalize an angle between 0 and 2 * PI.
static DoubleScalar.Abs<DirectionUnit,AngleUnit>	normalize(DoubleScalar.Abs<DirectionUnit,AngleUnit> angle) Normalize an angle between 0 and 2 * PI.
static DoubleScalar.Rel<AngleUnit>	normalize(DoubleScalar.Rel<AngleUnit> angle) Normalize an angle between 0 and 2 * PI.
static float	normalize(float angle) Normalize an angle between 0 and 2 * PI.
static FloatAngle	normalize(FloatAngle angle) Normalize an angle between 0 and 2 * PI.
static FloatDirection	normalize(FloatDirection angle) Normalize an angle between 0 and 2 * PI.
static FloatScalar.Abs<DirectionUnit,AngleUnit>	normalize(FloatScalar.Abs<DirectionUnit,AngleUnit> angle) Normalize an angle between 0 and 2 * PI.
static FloatScalar.Rel<AngleUnit>	normalize(FloatScalar.Rel<AngleUnit> angle) Normalize an angle between 0 and 2 * PI.

Method Detail

normalize

static double normalize(double angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - double; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static float normalize(float angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - float; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static DoubleScalar.Abs<DirectionUnit,AngleUnit> normalize(DoubleScalar.Abs<DirectionUnit,AngleUnit> angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - DoubleScalar.Abs<DirectionUnit,AngleUnit>; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static DoubleScalar.Rel<AngleUnit> normalize(DoubleScalar.Rel<AngleUnit> angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - DoubleScalar.Rel<AngleUnit>; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static FloatScalar.Abs<DirectionUnit,AngleUnit> normalize(FloatScalar.Abs<DirectionUnit,AngleUnit> angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - FloatScalar.Abs<DirectionUnit,AngleUnit>; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static FloatScalar.Rel<AngleUnit> normalize(FloatScalar.Rel<AngleUnit> angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - FloatScalar.Rel<AngleUnit>; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static Direction normalize(Direction angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - Direction; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static Angle normalize(Angle angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - Angle; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static FloatDirection normalize(FloatDirection angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - FloatDirection; original angle.

Returns:

angle between 0 and 2 * PI.

normalize

static FloatAngle normalize(FloatAngle angle)

Normalize an angle between 0 and 2 * PI.

Parameters:

angle - FloatAngle; original angle.

Returns:

angle between 0 and 2 * PI.