Class HingeJointDrive

Properties of a drive that drives the joint's angular velocity towards a paricular value.

Index

Constructors

Properties

_forceLimit _gearRatio _isFreeSpinEnabled _speed

Accessors

forceLimit gearRatio isFreeSpinEnabled speed

Methods

assign clone isEqual isEqual

Constructors

constructor

new HingeJointDrive(speed?, forceLimit?, gearRatio?, isFreeSpinEnabled?): HingeJointDrive
Parameters
- Optionalspeed: number
- OptionalforceLimit: number
- OptionalgearRatio: number
- OptionalisFreeSpinEnabled: boolean
Returns HingeJointDrive

Properties

`Protected`_forceLimit

_forceLimit: number

`Protected`_gearRatio

_gearRatio: number

`Protected`_isFreeSpinEnabled

_isFreeSpinEnabled: boolean

`Protected`_speed

_speed: number

Accessors

forceLimit

get forceLimit(): number
Maximum torque the drive is allowed to apply .

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

gearRatio

get gearRatio(): number
Scales the velocity of the first body, and its response to drive torque is scaled down.

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

isFreeSpinEnabled

get isFreeSpinEnabled(): boolean
If the joint is moving faster than the drive's target speed, the drive will try to break. If you don't want the breaking to happen set this to true.

Returns boolean
set isFreeSpinEnabled(value): void
Parameters
- value: boolean
Returns void

speed

get speed(): number
Target speed of the joint.

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

Methods

assign

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

clone

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

Returns HingeJointDrive

isEqual

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

`Static`isEqual

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