Angle

object Angle

Utility functions for working with angles. Unless otherwise noted, methods in this class express angles in radians.

class Object
trait Matchable
class Any

Value members

Concrete methods

def angle(p0: Coordinate, p1: Coordinate): Double

Returns the angle of the vector from p0 to p1, relative to the positive X-axis. The angle is normalized to be in the range [ -Pi, Pi ].

Returns the angle of the vector from p0 to p1, relative to the positive X-axis. The angle is normalized to be in the range [ -Pi, Pi ].

Value Params
p0

the initial point of the vector

p1

the terminal point of the vector return the normalized angle (in radians) that p0-p1 makes with the positive x-axis.

def angle(p: Coordinate): Double

Returns the angle of the vector from (0,0) to p, relative to the positive X-axis. The angle is normalized to be in the range ( -Pi, Pi ].

Returns the angle of the vector from (0,0) to p, relative to the positive X-axis. The angle is normalized to be in the range ( -Pi, Pi ].

Value Params
p

the terminal point of the vector return the normalized angle (in radians) that p makes with the positive x-axis.

def angleBetween(tip1: Coordinate, tail: Coordinate, tip2: Coordinate): Double

Returns the unoriented smallest angle between two vectors. The computed angle will be in the range [0, Pi).

Returns the unoriented smallest angle between two vectors. The computed angle will be in the range [0, Pi).

Value Params
tail

the tail of each vector

tip1

the tip of one vector

tip2

the tip of the other vector return the angle between tail-tip1 and tail-tip2

def angleBetweenOriented(tip1: Coordinate, tail: Coordinate, tip2: Coordinate): Double

Returns the oriented smallest angle between two vectors. The computed angle will be in the range (-Pi, Pi]. A positive result corresponds to a counterclockwise (CCW) rotation from v1 to v2; a negative result corresponds to a clockwise (CW) rotation; a zero result corresponds to no rotation.

Returns the oriented smallest angle between two vectors. The computed angle will be in the range (-Pi, Pi]. A positive result corresponds to a counterclockwise (CCW) rotation from v1 to v2; a negative result corresponds to a clockwise (CW) rotation; a zero result corresponds to no rotation.

Value Params
tail

the tail of each vector

tip1

the tip of v1

tip2

the tip of v2 return the angle between v1 and v2, relative to v1

def diff(ang1: Double, ang2: Double): Double

Computes the unoriented smallest difference between two angles. The angles are assumed to be normalized to the range [-Pi, Pi]. The result will be in the range [0, Pi].

Computes the unoriented smallest difference between two angles. The angles are assumed to be normalized to the range [-Pi, Pi]. The result will be in the range [0, Pi].

Value Params
ang1

the angle of one vector (in [-Pi, Pi] )

ang2

the angle of the other vector (in range [-Pi, Pi] ) return the angle (in radians) between the two vectors (in range [0, Pi] )

def getTurn(ang1: Double, ang2: Double): Int

Returns whether an angle must turn clockwise or counterclockwise to overlap another angle.

Returns whether an angle must turn clockwise or counterclockwise to overlap another angle.

Value Params
ang1

an angle (in radians)

ang2

an angle (in radians) return whether a1 must turn CLOCKWISE, COUNTERCLOCKWISE or NONE to overlap a2.

def interiorAngle(p0: Coordinate, p1: Coordinate, p2: Coordinate): Double

Computes the interior angle between two segments of a ring. The ring is assumed to be oriented in a clockwise direction. The computed angle will be in the range [0, 2Pi]

Computes the interior angle between two segments of a ring. The ring is assumed to be oriented in a clockwise direction. The computed angle will be in the range [0, 2Pi]

Value Params
p0

a point of the ring

p1

the next point of the ring

p2

the next point of the ring return the interior angle based at <code>p1</code>

def isAcute(p0: Coordinate, p1: Coordinate, p2: Coordinate): Boolean

Tests whether the angle between p0-p1-p2 is acute. An angle is acute if it is less than 90 degrees.

Tests whether the angle between p0-p1-p2 is acute. An angle is acute if it is less than 90 degrees.

Note: this implementation is not precise (deterministic) for angles very close to 90 degrees.

Value Params
p0

an endpoint of the angle

p1

the base of the angle

p2

the other endpoint of the angle return true if the angle is acute

def isObtuse(p0: Coordinate, p1: Coordinate, p2: Coordinate): Boolean

Tests whether the angle between p0-p1-p2 is obtuse. An angle is obtuse if it is greater than 90 degrees.

Tests whether the angle between p0-p1-p2 is obtuse. An angle is obtuse if it is greater than 90 degrees.

Note: this implementation is not precise (deterministic) for angles very close to 90 degrees.

Value Params
p0

an endpoint of the angle

p1

the base of the angle

p2

the other endpoint of the angle return true if the angle is obtuse

def normalize(angl: Double): Double

Computes the normalized value of an angle, which is the equivalent angle in the range ( -Pi, Pi ].

Computes the normalized value of an angle, which is the equivalent angle in the range ( -Pi, Pi ].

Value Params
angle

the angle to normalize return an equivalent angle in the range (-Pi, Pi]

def normalizePositive(angl: Double): Double

Computes the normalized positive value of an angle, which is the equivalent angle in the range [ 0, 2*Pi ). E.g.:

Computes the normalized positive value of an angle, which is the equivalent angle in the range [ 0, 2*Pi ). E.g.:

  • normalizePositive(0.0) = 0.0

  • normalizePositive(-PI) = PI

  • normalizePositive(-2PI) = 0.0

  • normalizePositive(-3PI) = PI

  • normalizePositive(-4PI) = 0

  • normalizePositive(PI) = PI

  • normalizePositive(2PI) = 0.0

  • normalizePositive(3PI) = PI

  • normalizePositive(4PI) = 0.0

Value Params
angle

the angle to normalize, in radians return an equivalent positive angle

def toDegrees(radians: Double): Double

Converts from radians to degrees.

Converts from radians to degrees.

Value Params
radians

an angle in radians return the angle in degrees

def toRadians(angleDegrees: Double): Double

Converts from degrees to radians.

Converts from degrees to radians.

Value Params
angleDegrees

an angle in degrees return the angle in radians

Concrete fields

val CLOCKWISE: Int

Constant representing clockwise orientation

Constant representing clockwise orientation

Constant representing counterclockwise orientation

Constant representing counterclockwise orientation

val NONE: Int

Constant representing no orientation

Constant representing no orientation

val PI_OVER_2: Double

The value of Pi/2

The value of Pi/2

val PI_OVER_4: Double

The value of Pi/4

The value of Pi/4

val PI_TIMES_2: Double

The value of 2*Pi

The value of 2*Pi