Class: ThreeTransformPort

Defined in: threejs-interactions/src/transform-port.ts:20

The transform/effect surface of ONE interactable's scene object. Behaviours write through this; the adapter owns how writes land (Object3D fields, ECS components, …).

Offsets/rotations are FROM REST: the adapter captures the rest pose at registration and applies these relative to it, so behaviours compose with anything else animating the same object (the pale-signal non-destructive-offset rule).

Implements

• TransformPort

Constructors

Constructor

new ThreeTransformPort(object: Object3D): ThreeTransformPort;

Defined in: threejs-interactions/src/transform-port.ts:33

Parameters

Parameter	Type
object	Object3D

Returns

ThreeTransformPort

Methods

getLocalOffset()

getLocalOffset(): Vec3Tuple;

Defined in: threejs-interactions/src/transform-port.ts:61

Local-space pose relative to the captured rest (dragged observation).

Returns

Vec3Tuple

Implementation of

TransformPort.getLocalOffset

---

getWorldPose()

getWorldPose(): PoseTuple;

Defined in: threejs-interactions/src/transform-port.ts:44

Current world pose.

Returns

PoseTuple

Implementation of

TransformPort.getWorldPose

---

recaptureRest()

recaptureRest(): void;

Defined in: threejs-interactions/src/transform-port.ts:38

Returns

void

---

setEffect()

setEffect(effect: {
  emissive?: number;
  scale?: number;
}): void;

Defined in: threejs-interactions/src/transform-port.ts:93

Additive presentation effect (pulse): scale multiplier & emissive boost.

Parameters

Parameter	Type
effect	{ emissive?: number; scale?: number; }
effect.emissive?	number
effect.scale?	number

Returns

void

Implementation of

TransformPort.setEffect

---

setLocalOffset()

setLocalOffset(offset: Vec3Tuple): void;

Defined in: threejs-interactions/src/transform-port.ts:68

Additive local-space offset from rest (driven press / slide).

Parameters

Parameter	Type
offset	Vec3Tuple

Returns

void

Implementation of

TransformPort.setLocalOffset

---

setLocalRotation()

setLocalRotation(quaternion: QuatTuple): void;

Defined in: threejs-interactions/src/transform-port.ts:73

Local rotation about the rest orientation (hinge / dial output).

Parameters

Parameter	Type
quaternion	QuatTuple

Returns

void

Implementation of

TransformPort.setLocalRotation

---

setWorldPose()

setWorldPose(pose: PoseTuple): void;

Defined in: threejs-interactions/src/transform-port.ts:78

Follow a world pose while grabbed (poseOnly grab fulfilment).

Parameters

Parameter	Type
pose	PoseTuple

Returns

void

Implementation of

TransformPort.setWorldPose