Class Spring

Controls spring parameters for a physics joint limits. If a limit is soft (body bounces back due to restition when the limit is reached) the spring will pull the body back towards the limit using the specified parameters.

Index

Constructors

Properties

_damping _stiffness

Accessors

damping stiffness

Methods

assign clone isEqual isEqual

Constructors

constructor

new Spring(stiffness?: number, damping?: number): Spring
Parameters
- Optionalstiffness: number
- Optionaldamping: number
Returns Spring

Properties

`Protected`_damping

_damping: number

`Protected`_stiffness

_stiffness: number

Accessors

damping

get damping(): number

Damping strength. Force propertional to the velocity error.

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

stiffness

get stiffness(): number

Spring strength. Force proportional to the position error.

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

Methods

assign

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

clone

clone(): Spring

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

Returns Spring

isEqual

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

`Static`isEqual

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