Class LimitLinear

Represents a joint limit between zero a single distance value.

Index

Constructors

Properties

_extent _spring

Accessors

Methods

assign clone isEqual isEqual

Constructors

constructor

new LimitLinear(extent?, spring?): LimitLinear
Parameters
- Optionalextent: number
- Optionalspring: Immutable<Spring>
Returns LimitLinear

Properties

`Protected`_extent

_extent: number

`Protected`_spring

_spring: Spring

Accessors

extent

get extent(): number
Distance at which the limit becomes active.

Returns number
set extent(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

Methods

assign

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

clone

clone(): LimitLinear
Clones this instance and returns a new LimitLinear with identical values.

Returns LimitLinear

isEqual

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

`Static`isEqual

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