eulerjs API / @eulerjs/core / BaseJoint
BaseJoint
Defined in: packages/core/src/joints/BaseJoint.ts:22
What every joint has: the bodies it ties, the loads it carries and when it breaks.
Extended by
Constructors
Constructor
ts
new BaseJoint(options): BaseJoint;Defined in: packages/core/src/joints/BaseJoint.ts:44
Parameters
| Parameter | Type |
|---|---|
options | BaseJointOptions |
Returns
BaseJoint
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
bodyA | readonly | Body | undefined | - | packages/core/src/joints/BaseJoint.ts:23 |
bodyB | readonly | Body | undefined | undefined | - | packages/core/src/joints/BaseJoint.ts:24 |
breakForce | public | number | undefined | - | packages/core/src/joints/BaseJoint.ts:32 |
breakTorque | public | number | undefined | - | packages/core/src/joints/BaseJoint.ts:33 |
broken | public | boolean | false | Set once the joint has broken. | packages/core/src/joints/BaseJoint.ts:42 |
collideConnectedSetting | readonly | boolean | "unlessOverlapping" | undefined | As asked for, before a world decides 'unlessOverlapping'. | packages/core/src/joints/BaseJoint.ts:30 |
force | readonly | Vector3 | ... | The force the joint put on body B over the last step (on body A, for a joint to the world), in N, world space; on the other it is the opposite. Written by the backend. | packages/core/src/joints/BaseJoint.ts:38 |
torque | readonly | Vector3 | ... | The torque the joint put on the same body over the last step, in N·m. Written by the backend. | packages/core/src/joints/BaseJoint.ts:40 |
Accessors
bodies
Get Signature
ts
get bodies(): readonly Body[];Defined in: packages/core/src/joints/BaseJoint.ts:59
The bodies the joint ties together.
Returns
readonly Body[]
collideConnected
Get Signature
ts
get collideConnected(): boolean;Defined in: packages/core/src/joints/BaseJoint.ts:26
Whether the two bodies collide with each other; fixed once the joint is in a world.
Returns
boolean
isOverloaded
Get Signature
ts
get isOverloaded(): boolean;Defined in: packages/core/src/joints/BaseJoint.ts:64
Whether the loads of the last step are more than the joint can take.
Returns
boolean