eulerjs API / @eulerjs/core / TargetJoint

TargetJoint

Defined in: packages/core/src/joints/presets.ts:167

Pulls a body toward a pose in the world, as a spring and damper with limits: for dragging a body with the mouse, carrying it, or leading an active ragdoll along by its hips. Move the target with setTarget as often as you like. It pulls as hard as a spring of its frequency on the body's mass, so a body it holds up sags by g / (2π frequency)²; take away its gravity (gravityScale = 0) to have it hold the pose exactly.

Extends

• SixDofJoint

Constructors

Constructor

new TargetJoint(options): TargetJoint;

Defined in: packages/core/src/joints/presets.ts:170

Parameters

Parameter	Type
options	TargetJointOptions

Returns

TargetJoint

Overrides

SixDofJoint.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
angular	readonly	SixAxes<AxisMotion>	undefined	-	SixDofJoint.angular	packages/core/src/joints/SixDofJoint.ts:118
angularDrives	readonly	SixAxes<JointDrive | undefined>	undefined	-	SixDofJoint.angularDrives	packages/core/src/joints/SixDofJoint.ts:120
bodyA	readonly	Body	undefined	-	SixDofJoint.bodyA	packages/core/src/joints/BaseJoint.ts:23
bodyB	readonly	Body | undefined	undefined	-	SixDofJoint.bodyB	packages/core/src/joints/BaseJoint.ts:24
breakForce	public	number	undefined	-	SixDofJoint.breakForce	packages/core/src/joints/BaseJoint.ts:32
breakTorque	public	number	undefined	-	SixDofJoint.breakTorque	packages/core/src/joints/BaseJoint.ts:33
broken	public	boolean	false	Set once the joint has broken.	SixDofJoint.broken	packages/core/src/joints/BaseJoint.ts:42
collideConnectedSetting	readonly	boolean | "unlessOverlapping"	undefined	As asked for, before a world decides 'unlessOverlapping'.	SixDofJoint.collideConnectedSetting	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.	SixDofJoint.force	packages/core/src/joints/BaseJoint.ts:38
frameA	readonly	JointFrame	undefined	-	SixDofJoint.frameA	packages/core/src/joints/SixDofJoint.ts:115
frameB	readonly	JointFrame	undefined	-	SixDofJoint.frameB	packages/core/src/joints/SixDofJoint.ts:116
friction	public	number	undefined	-	SixDofJoint.friction	packages/core/src/joints/SixDofJoint.ts:122
linear	readonly	SixAxes<AxisMotion>	undefined	-	SixDofJoint.linear	packages/core/src/joints/SixDofJoint.ts:117
linearDrives	readonly	SixAxes<JointDrive | undefined>	undefined	-	SixDofJoint.linearDrives	packages/core/src/joints/SixDofJoint.ts:119
linearFriction	public	number	undefined	-	SixDofJoint.linearFriction	packages/core/src/joints/SixDofJoint.ts:123
orientationDrive	public	OrientationDrive | undefined	undefined	-	SixDofJoint.orientationDrive	packages/core/src/joints/SixDofJoint.ts:121
torque	readonly	Vector3	...	The torque the joint put on the same body over the last step, in N·m. Written by the backend.	SixDofJoint.torque	packages/core/src/joints/BaseJoint.ts:40

Accessors

bodies

Get Signature

get bodies(): readonly Body[];

Defined in: packages/core/src/joints/BaseJoint.ts:59

The bodies the joint ties together.

Returns

readonly Body[]

Inherited from

SixDofJoint.bodies

---

collideConnected

Get Signature

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

Inherited from

SixDofJoint.collideConnected

---

frequency

Get Signature

get frequency(): number;

Defined in: packages/core/src/joints/presets.ts:200

How fast it springs to the target, in Hz; 0 lets the body go.

Returns

number

Set Signature

set frequency(frequency): void;

Defined in: packages/core/src/joints/presets.ts:204

Parameters

Parameter	Type
frequency	number

Returns

void

---

isOverloaded

Get Signature

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

Inherited from

SixDofJoint.isOverloaded

---

roles

Get Signature

get roles(): object;

Defined in: packages/core/src/joints/SixDofJoint.ts:153

The joint's base frame and the frame that moves against it: frame A on body A and frame B on body B; or, for a joint to the world, the world's frame (frameB) and body A's (frameA), so that either way what is measured is how the second body moves.

Returns

object

Name	Type	Defined in
base	JointFrame	packages/core/src/joints/SixDofJoint.ts:153
baseBody	Body | undefined	packages/core/src/joints/SixDofJoint.ts:153
moving	JointFrame	packages/core/src/joints/SixDofJoint.ts:153
movingBody	Body	packages/core/src/joints/SixDofJoint.ts:153

Inherited from

SixDofJoint.roles

---

target

Get Signature

get target(): JointFrame;

Defined in: packages/core/src/joints/presets.ts:195

Where the anchor is pulled to and how the body is turned, in world space.

Returns

JointFrame

Methods

measure()

measure(): JointMeasurement;

Defined in: packages/core/src/joints/SixDofJoint.ts:160

Where the moving frame is relative to the base frame (see roles), as the bodies are now.

Returns

JointMeasurement

Inherited from

SixDofJoint.measure

---

setTarget()

setTarget(
   position, 
   quaternion?, 
   velocity?
): void;

Defined in: packages/core/src/joints/presets.ts:213

Moves the target: where to pull the anchor to, how to turn the body, and how fast the target itself is moving, which the body is pulled to match so that it keeps up instead of lagging.

Parameters

Parameter	Type
position	Vector3
quaternion?	Quaternion
velocity?	Vector3

Returns

void