Packagecom.bourre.structures
Classpublic class Range

Player version: Flash Player 9.0
Language version: ActionScript 3.0

A range represent a space of numeric values.


Example
Simple examples of Range usage
    var r1 : Range = new Range(10, 100);
    var r2 : Range = new Range(5, 50);
    var r3 : Range = new Range(60, 600);
    
    var b1 : Boolean = r1.overlap(r2); //true
    var b2 : Boolean = r2.overlap(r3); //false
    var b3 : Boolean = r1.overlap(r3); //true
  



Public Properties
 PropertyDefined by
  max : Number
Upper limit of the range.
Range
  min : Number
Lower limit of the range.
Range
Public Methods
 MethodDefined by
  
Range(min:Number, max:Number)
Constructs a new Range instance.
Range
  
Returns a copy of the current Range object.
Range
  
equals(r:Range):Boolean
Compares the passed-in Range object with the current one.
Range
  
inside(r:Range):Boolean
Indicates if passed-in Range instance contain the current instance.
Range
  
overlap(r:Range):Boolean
Indicates if passed-in range overlap the current range.
Range
  
size():Number
Returns the size, or length, of the current range.
Range
  
surround(n:Number):Boolean
Indicates if passed-in value Number is inside range values.
Range
  
toString():String
Returns the string representation of this instance.
Range
Property detail
maxproperty
public var max:Number

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Upper limit of the range.

minproperty 
public var min:Number

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Lower limit of the range.

Constructor detail
Range()constructor
public function Range(min:Number, max:Number)

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Constructs a new Range instance.

Warning : parameter order is important. Parameters

min:Number — minimum Number value
 
max:Number — maximum Number value
Method detail
clone()method
public function clone():Range

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns a copy of the current Range object.

Returns
Range — A Range object.
equals()method 
public function equals(r:Range):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Compares the passed-in Range object with the current one.

Parameters
r:Range — A Range to compare.

Returns
Booleantrue if passed-in Range is equals to this one, either false
inside()method 
public function inside(r:Range):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Indicates if passed-in Range instance contain the current instance.

Parameters
r:Range

Returns
Booleantrue if passed-in Range contain this one, either false

Example
     var r1 : Range = new Range(10, 100);
     var r2 : Range = new Range(5, 50);
     var r3 : Range = new Range(40, 80);
     
     var b2 : Boolean = r2.inside( r1 ); //false
     var b3 : Boolean = r3.inside( r1 ); //true
   

overlap()method 
public function overlap(r:Range):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Indicates if passed-in range overlap the current range.

Parameters
r:Range

Returns
Booleantrue if passed-in Range overload this one, either false

Example
     var r1 : Range = new Range(10, 100);
     var r2 : Range = new Range(5, 50);
     var r3 : Range = new Range(60, 600);
     
     var b1 : Boolean = r1.overlap(r2); //true
     var b2 : Boolean = r2.overlap(r3); //false
     var b3 : Boolean = r1.overlap(r3); //true
   

size()method 
public function size():Number

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the size, or length, of the current range.

Returns
Number — size, or length, of the current range.
surround()method 
public function surround(n:Number):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Indicates if passed-in value Number is inside range values.

Parameters
n:Number

Returns
Booleantrue if passed-in Number is inside range, either false

Example
     var r : Range = new Range(10, 100);
   
     var b1 : Boolean = r.surround(35); //true
     var b2 : Boolean = r.surround(127); //false
     var b3 : Boolean = r.surround(10); //true
     var b4 : Boolean = r.surround(100); //true
     var b5 : Boolean = r.surround(5); //false
   

toString()method 
public function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the string representation of this instance.

Returns
StringString representation of this instance