Skip to content

eulerjs API / @eulerjs/core / DistanceJointOptions

DistanceJointOptions ​

Defined in: packages/core/src/joints/DistanceJoint.ts:5

Extends ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
anchorA?Vector3Where the joint holds body A, in its own frame. Defaults to its frame origin.-packages/core/src/joints/DistanceJoint.ts:7
anchorB?Vector3Where the joint holds body B, in its own frame; or, without body B, the fixed point in world space.-packages/core/src/joints/DistanceJoint.ts:9
bodyABody-BaseJointOptions.bodyApackages/core/src/joints/BaseJoint.ts:5
bodyB?BodyThe other body. Leave out to tie body A to the world.BaseJointOptions.bodyBpackages/core/src/joints/BaseJoint.ts:7
breakForce?numberThe joint breaks, and the world removes it, once it carries more force than this, in newtons. Defaults to Infinity.BaseJointOptions.breakForcepackages/core/src/joints/BaseJoint.ts:16
breakTorque?numberThe joint breaks once it carries more torque than this, in newton metres. Defaults to Infinity.BaseJointOptions.breakTorquepackages/core/src/joints/BaseJoint.ts:18
collideConnected?boolean | "unlessOverlapping"Whether the two bodies still collide with each other. Defaults to true; turn it off for parts that overlap where they are joined, such as a ragdoll's thigh and shin. 'unlessOverlapping' decides when the joint is added to the world: they collide unless their colliders overlap then, as joined limbs do and a shoulder that clears the chest doesn't.BaseJointOptions.collideConnectedpackages/core/src/joints/BaseJoint.ts:14
compliance?numberSoftness in m/N: 0 is a rigid rod; larger values stretch like a spring of stiffness 1 / compliance.-packages/core/src/joints/DistanceJoint.ts:13
damping?numberHow fast motion along the joint dies out, per second.-packages/core/src/joints/DistanceJoint.ts:17
length?numberThe distance to keep. Defaults to the distance between the anchors when the joint is made.-packages/core/src/joints/DistanceJoint.ts:11
slack?booleanLike a rope: only resists being stretched, and goes slack when the anchors come closer.-packages/core/src/joints/DistanceJoint.ts:15

Released under the MIT License.