Class LimitLinearRange

Represents a joint limit between two distance values. Lower value must be less than the upper value.

Index

Constructors

Properties

_lower _spring _upper

Accessors

lower spring upper

Methods

assign clone isEqual isEqual

Constructors

constructor

new LimitLinearRange(
    lower?: number,
    upper?: number,
    spring?: Immutable<Spring>,
): LimitLinearRange
Parameters
- Optionallower: number
- Optionalupper: number
- Optionalspring: Immutable<Spring>
Returns LimitLinearRange

Properties

`Protected`_lower

_lower: number

`Protected`_spring

_spring: Spring

`Protected`_upper

_upper: number

Accessors

lower

get lower(): number

Lower distance of the limit. Must be less than #upper.

Returns number
set lower(value: number): void
Parameters
- value: number
Returns void

spring

get spring(): Spring

Spring that controls how are the bodies pulled back towards the limit when they breach it.

Returns Spring
set spring(value: Immutable<Spring>): void
Parameters
- value: Immutable<Spring>
Returns void

upper

get upper(): number

Upper distance of the limit. Must be more than #lower.

Returns number
set upper(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<LimitLinearRange>): LimitLinearRange
Copies all properties defined by the prototype of LimitLinearRange from other to this instance.
Parameters
- other: Immutable<LimitLinearRange>
Returns LimitLinearRange

clone

clone(): LimitLinearRange

Clones this instance and returns a new LimitLinearRange with identical values.

Returns LimitLinearRange

isEqual

isEqual(
this: Immutable<LimitLinearRange>,
other: Immutable<LimitLinearRange>,
): boolean
Determines if this LimitLinearRange instance is equal to the other instance.
Parameters
- this: Immutable<LimitLinearRange>
- other: Immutable<LimitLinearRange>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<LimitLinearRange>,
rhs: Immutable<LimitLinearRange>,
): boolean
Determines if both LimitLinearRange instances are equal.
Parameters
- lhs: Immutable<LimitLinearRange>
- rhs: Immutable<LimitLinearRange>
Returns boolean