Class Range

The Range class is a range from minimum to maximum.

Hierarchy

Range

Index

Constructors

Properties

m_maximum m_minimum

Accessors

maximum minimum

Methods

add addValue center clone compare copy inRange isValid length relativeOf set unset

Constructors

constructor

new Range(minimum?, maximum?): Range
Constructs a range with the given minimum and maximum.
Parameters
- minimum: number = 0
  
  The default value is 0.
- maximum: number = 1.0
  
  The default value is 1.0.
Returns Range
- Defined in core/range.ts:13

Properties

`Private` m_maximum

m_maximum: number

`Private` m_minimum

m_minimum: number

Accessors

maximum

get maximum(): number
Returns the range's maximum value.

Returns number
- Defined in core/range.ts:35
set maximum(maximum): void
Sets the range's maximum value to maximum.
Parameters
- maximum: number
Returns void
- Defined in core/range.ts:42

minimum

get minimum(): number
Returns the range's minimum value.

Returns number
- Defined in core/range.ts:21
set minimum(minimum): void
Sets the range's minimum value to minimum.
Parameters
- minimum: number
Returns void
- Defined in core/range.ts:28

Methods

add

add(range): void
Adds the given range to this range.
Parameters
- range: Range
Returns void
- Defined in core/range.ts:104

addValue

addValue(value): void
Adds the given value to this range.
Parameters
- value: number
Returns void
- Defined in core/range.ts:112

center

center(): number
Returns the center value of the range.

Returns number
- Defined in core/range.ts:57

clone

clone(): Range
Returns a copy of this range.

Returns Range
- Defined in core/range.ts:128

compare

compare(other): boolean
Returns true if this range and other are equal; otherwise returns false.
Parameters
- other: Range
Returns boolean
- Defined in core/range.ts:135

copy

copy(other): void
Copies the other range to this range.
Parameters
- other: Range
Returns void
- Defined in core/range.ts:120

inRange

inRange(value): boolean
Returns true if the given value is in the range, otherwise returns false.
Parameters
- value: number
Returns boolean
- Defined in core/range.ts:71

isValid

isValid(): boolean
Returns true if the range is valid(minimum <= maximum), otherwise returns false.

Returns boolean
- Defined in core/range.ts:89

length

length(): number
Returns the length of the range.

Returns number
- Defined in core/range.ts:64

relativeOf

relativeOf(value): number
Returns the ratio of the given value to the range.
Parameters
- value: number
Returns number
- Defined in core/range.ts:78

set

set(minimum, maximum): void
Sets the range's minimum and maximum value.
Parameters
- minimum: number
- maximum: number
Returns void
- Defined in core/range.ts:49

unset

unset(): void
Resets the range.

Returns void
- Defined in core/range.ts:96

Generated using TypeDoc