Skip to main content

Interface: TransformPort

Defined in: ports.ts:37

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).

Methods

getLocalOffset()

getLocalOffset(): Vec3Tuple;

Defined in: ports.ts:41

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

Returns

Vec3Tuple


getWorldPose()

getWorldPose(): PoseTuple;

Defined in: ports.ts:39

Current world pose.

Returns

PoseTuple


setEffect()?

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

Defined in: ports.ts:49

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

Parameters

ParameterType
effect{ emissive?: number; scale?: number; }
effect.emissive?number
effect.scale?number

Returns

void


setLocalOffset()

setLocalOffset(offset: Vec3Tuple): void;

Defined in: ports.ts:43

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

Parameters

ParameterType
offsetVec3Tuple

Returns

void


setLocalRotation()

setLocalRotation(quaternion: QuatTuple): void;

Defined in: ports.ts:45

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

Parameters

ParameterType
quaternionQuatTuple

Returns

void


setWorldPose()?

optional setWorldPose(pose: PoseTuple): void;

Defined in: ports.ts:47

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

Parameters

ParameterType
posePoseTuple

Returns

void