Class LimitLinearRange

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

Index

Constructors

Properties

_contactDistance _lower _restitution _spring _upper

Accessors

contactDistance lower restitution spring upper

Methods

assign clone isEqual isEqual

Constructors

constructor

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

Properties

`Protected`_contactDistance

_contactDistance: number

`Protected`_lower

_lower: number

`Protected`_restitution

_restitution: number

`Protected`_spring

_spring: Spring

`Protected`_upper

_upper: number

Accessors

contactDistance

get contactDistance(): number
Distance from the limit at which it becomes active. Allows the solver to activate earlier than the limit is reached to avoid breaking the limit.

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

lower

get lower(): number
Lower distance of the limit. Must be less than #upper.

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

restitution

get restitution(): number
Controls how do objects react when the limit is reached, values closer to zero specify non-ellastic collision, while those closer to one specify more ellastic (i.e bouncy) collision. Must be in [0, 1] range.

Returns number
set restitution(value): 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): 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): void
Parameters
- value: number
Returns void

Methods

assign

assign(other): 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, other): 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, rhs): boolean
Determines if both LimitLinearRange instances are equal.
Parameters
- lhs: Immutable<LimitLinearRange>
- rhs: Immutable<LimitLinearRange>
Returns boolean