| Package | system.numeric |
| Class | public class Range |
| Inheritance | Range  Object |
| Implements | Equatable, Serializable |
Example :
import system.numeric.Range ;
var r1:Range = new Range(10, 120) ;
var r2:Range = new Range(100, 150) ;
trace ("r1 : " + r1) ; // r1 : [Range$lt;10,120$gt;]
trace ("r2 : " + r2) ; // r2 : [Range$lt;100,150$gt;]
trace ("r2.toSource() : " + r2.toSource() ) ; // r2.toSource() : new system.numeric.Range(100,150)
trace ("r1 contains 50 : " + r1.contains(50) ) ; // r1 contains 50 : true
trace ("r1 isOutOfRange 5 : " + r1.isOutOfRange(5) ) ; // r1 isOutOfRange 5 : true
trace ("r1 overlap r2 : " + r1.overlap(r2) ) ; // r1 overlap r2 : true
trace ("r1 clamp 5 : " + r1.clamp(5) ) ; // r1 clamp 5 : 10
trace ("r1 clamp 121 : " + r1.clamp(121) ) ; // r1 clamp 121 : 120
| Property | Defined By | ||
|---|---|---|---|
| max : Number
The max value of the range. | Range | ||
| min : Number
The min value of the range. | Range | ||
| Method | Defined By | ||
|---|---|---|---|
Range(min:Number, max:Number)
Creates a new Range instance. | Range | ||
clamp(value:Number):Number
Clamp a value in the current range. | Range | ||
clone():*
Returns a shallow copy of the object. | Range | ||
Creates a new range by combining two existing ranges. | Range | ||
contains(value:Number):Boolean
Returns true if the Range instance contains the value passed in argument. | Range | ||
equals(o:*):Boolean
Indicates whether some other object is "equal to" this one. | Range | ||
Creates a new range by adding margins to an existing range. | Range | ||
filterNaNValue(value:Number, defaultValue:Number = 0):Number [static]
Filters the passed-in Number value, if the value is NaN the return value is the default value in second argument. | Range | ||
getCentralValue():Number
Returns the central value for the range. | Range | ||
getRandomFloat():Number
Returns a random floating-point number between two numbers. | Range | ||
getRandomInteger():int
Returns a random integer number between two numbers. | Range | ||
isOutOfRange(value:Number):Boolean
Returns true if the value is out of the range. | Range | ||
Returns true if the range in argument overlap the current range. | Range | ||
size():Number
Returns the length of the range. | Range | ||
toSource(indent:int = 0):String
Returns the source represensation of the object. | Range | ||
toString():String
Returns the string representation of this instance. | Range | ||
| Constant | Defined By | ||
|---|---|---|---|
| COLOR : Range [static]
Range reference between -255 and 255. | Range | ||
| DEGREE : Range [static]
Range reference between 0 and 360. | Range | ||
| PERCENT : Range [static]
Range reference between 0 and 100. | Range | ||
| UNITY : Range [static]
Range reference between 0 and 1. | Range | ||
| max | property |
public var max:NumberThe max value of the range.
| min | property |
public var min:NumberThe min value of the range.
| Range | () | Constructor |
public function Range(min:Number, max:Number)Creates a new Range instance.
Usage :
var r:Range = new Range( min:Number, max:Number) ;Parameters
min:Number | |
max:Number |
| clamp | () | method |
public function clamp(value:Number):NumberClamp a value in the current range.
Parameters
value:Number |
Number |
| clone | () | method |
public function clone():*Returns a shallow copy of the object.
Returns* — a shallow copy of the object.
|
| combine | () | method |
public function combine(range:Range):RangeCreates a new range by combining two existing ranges.
Parameters
range:Range — the range to combine, null permitted.
|
Range |
| contains | () | method |
public function contains(value:Number):Boolean
Returns true if the Range instance contains the value passed in argument.
Parameters
value:Number |
Boolean — true if the Range instance contains the value passed in argument.
|
| equals | () | method |
public function equals(o:*):BooleanIndicates whether some other object is "equal to" this one.
Parameters
o:* |
Boolean |
| expand | () | method |
public function expand(lowerMargin:Number = 1, upperMargin:Number = 1):RangeCreates a new range by adding margins to an existing range.
Parameters
lowerMargin:Number (default = 1) | |
upperMargin:Number (default = 1) |
Range — The expanded range.
|
| filterNaNValue | () | method |
public static function filterNaNValue(value:Number, defaultValue:Number = 0):NumberFilters the passed-in Number value, if the value is NaN the return value is the default value in second argument.
Parameters
value:Number — The Number value to filter, if this value is NaN the value is changed.
| |
defaultValue:Number (default = 0) |
Number — The filter Number value.
|
| getCentralValue | () | method |
public function getCentralValue():NumberReturns the central value for the range.
ReturnsNumber — The central value.
|
| getRandomFloat | () | method |
public function getRandomFloat():NumberReturns a random floating-point number between two numbers.
ReturnsNumber — a random floating-point number between two numbers.
|
| getRandomInteger | () | method |
public function getRandomInteger():intReturns a random integer number between two numbers.
Returnsint — a random integer number between two numbers.
|
| isOutOfRange | () | method |
public function isOutOfRange(value:Number):Boolean
Returns true if the value is out of the range.
Parameters
value:Number |
Boolean — true if the value is out of the range.
|
| overlap | () | method |
public function overlap(r:Range):Boolean
Returns true if the range in argument overlap the current range.
Parameters
r:Range |
Boolean — true if the range in argument overlap the current range.
|
| size | () | method |
public function size():NumberReturns the length of the range.
ReturnsNumber — the length of the range.
|
| toSource | () | method |
public function toSource(indent:int = 0):StringReturns the source represensation of the object.
Parameters
indent:int (default = 0) |
String — the source represensation of the object.
|
| toString | () | method |
public function toString():StringReturns the string representation of this instance.
ReturnsString — the string representation of this instance.
|
| COLOR | Constant |
public static const COLOR:RangeRange reference between -255 and 255.
| DEGREE | Constant |
public static const DEGREE:RangeRange reference between 0 and 360.
| PERCENT | Constant |
public static const PERCENT:RangeRange reference between 0 and 100.
| UNITY | Constant |
public static const UNITY:RangeRange reference between 0 and 1.