Packagecom.threerings.util
Classpublic class MathUtil

Collection of math utility functions.


Public Methods
 MethodDefined by
  
clamp(n:Number, min:Number, max:Number):Number
[static] Returns the value of n clamped to be within the range [min, max].
MathUtil
  
distance(x1:Number, y1:Number, x2:Number, y2:Number, p:Number = 2):Number
[static] Returns distance from point (x1, y1) to (x2, y2) in 2D.
MathUtil
  
normalizeDegrees(degrees:Number):Number
[static] Normalizes an angle in degrees to occupy the [0, 360) range.
MathUtil
  
normalizeRadians(radians:Number):Number
[static] Normalizes an angle in radians to occupy the [0, 2pi) range.
MathUtil
  
toDegrees(radians:Number):Number
[static] Converts radians to degrees.
MathUtil
  
toRadians(degrees:Number):Number
[static] Converts degrees to radians.
MathUtil
Method detail
clamp()method
public static function clamp(n:Number, min:Number, max:Number):Number

Returns the value of n clamped to be within the range [min, max].

Parameters
n:Number
 
min:Number
 
max:Number

Returns
Number
distance()method 
public static function distance(x1:Number, y1:Number, x2:Number, y2:Number, p:Number = 2):Number

Returns distance from point (x1, y1) to (x2, y2) in 2D.

Supports various distance metrics: the common Euclidean distance, taxicab distance, arbitrary Minkowski distances, and Chebyshev distance.

See the NIST web page on distance definitions.

Parameters

x1:Number — x value of the first point
 
y1:Number — y value of the first point
 
x2:Number — x value of the second point
 
y2:Number — y value of the second point
 
p:Number (default = 2) — Optional: p value of the norm function. Common cases:
  • p = 2 (default): standard Euclidean distance on a plane
  • p = 1: taxicab distance (aka Manhattan distance)
  • p = Infinity: Chebyshev distance
Note: p < 1 or p = NaN are treated as equivalent to p = Infinity

Returns
Number
normalizeDegrees()method 
public static function normalizeDegrees(degrees:Number):Number

Normalizes an angle in degrees to occupy the [0, 360) range.

Parameters
degrees:Number

Returns
Number
normalizeRadians()method 
public static function normalizeRadians(radians:Number):Number

Normalizes an angle in radians to occupy the [0, 2pi) range.

Parameters
radians:Number

Returns
Number
toDegrees()method 
public static function toDegrees(radians:Number):Number

Converts radians to degrees.

Parameters
radians:Number

Returns
Number
toRadians()method 
public static function toRadians(degrees:Number):Number

Converts degrees to radians.

Parameters
degrees:Number

Returns
Number



Copyright © 2007-2009 Three Rings Design, Inc.