Class Range

The Range class represents a one-dimensional range, going from some start value to some end value.

Within the rest of the shimi architecture, this is most often used as a way to represent some range of time.

Hierarchy

Range
Hierarchy

Index

Constructors

Accessors

duration end start

Methods

contains getPercent

Constructors

constructor

new Range(start: number, duration: number): Range
Parameters
- start: number
  
  The value which the range starts at.
- duration: number
  
  The duration of the range.
Returns Range
- Defined in Range.ts:43

Accessors

duration

get duration(): number
The difference between the start and end values.

Attempts to set this to a negative value will result in an error being thrown.

Returns number
- Defined in Range.ts:23
set duration(value: number): void
Parameters
- value: number
Returns void
- Defined in Range.ts:24

end

get end(): number
The value which the range ends at.

Attempts to set this to a value less than start will result in an error being thrown.

Returns number
- Defined in Range.ts:36
set end(value: number): void
Parameters
- value: number
Returns void
- Defined in Range.ts:37

start

get start(): number
The value which the range starts at.

Attempts to set this to a value greater than end will result in an error being thrown.

Returns number
- Defined in Range.ts:14
set start(value: number): void
Parameters
- value: number
Returns void
- Defined in Range.ts:15

Methods

contains

contains(point: number): boolean
Returns true if the passed in point is greater than or equal to range start, and less than or equal to range end.

Returns
Parameters
- point: number
  
  The point value to determine whether it's within the range.
Returns boolean
- Defined in Range.ts:66

getPercent

getPercent(value: number): number
Accepts a value and returns what percentage of the way into the range that the value is.

The returned value can be negative, or greater than 100%, if the passed in value is less than the range start, or greater than the range end.

Returns
Parameters
- value: number
  
  The value to compare against the range.
Returns number
- Defined in Range.ts:55

Generated using TypeDoc