Class LimitCommon

Contains common values used by all Joint limit types.

Index

Constructors

Properties

Accessors

Methods

assign clone isEqual isEqual

Constructors

constructor

new LimitCommon(spring?: Immutable<Spring>): LimitCommon
Parameters
- Optionalspring: Immutable<Spring>
Returns LimitCommon

Properties

`Protected`_spring

_spring: Spring

Accessors

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

Methods

assign

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

clone

clone(): LimitCommon

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

Returns LimitCommon

isEqual

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

`Static`isEqual

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