Intermact API Reference / @intermact/core / RegisteredObject3D

Class: RegisteredObject3D

Defined in: packages/core/src/scene/registered-object-3d.ts:34

A 3D object registered into a Scene3D (design.md §9.2, §10). Mirrors RegisteredObject2D: its methods return seekable Animation handles (data) that tween the object's RuntimeState3D. 3D transform tweens carry space: "3d" so rotation interpolates via quaternion slerp.

Extended by

• RegisteredAxes3D

Constructors

Constructor

new RegisteredObject3D(id, object, transform): RegisteredObject3D

Defined in: packages/core/src/scene/registered-object-3d.ts:38

Parameters

id

string

object

IMObject3D

transform

Transform3D

Returns

RegisteredObject3D

Properties

id

readonly id: string

Defined in: packages/core/src/scene/registered-object-3d.ts:39

---

object

object: IMObject3D

Defined in: packages/core/src/scene/registered-object-3d.ts:35

---

parentId?

optional parentId?: string

Defined in: packages/core/src/scene/registered-object-3d.ts:36

Methods

create()

create(options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:115

Create: progressively reveal the object (revealEnd 0→1). The renderer trims lines by arc length and reveals mesh/point geometry by build order (design.md §11). Baseline hidden state is applied when played into the Storyboard.

Parameters

options?

Create3DOptions

Returns

Animation

---

fadeIn()

fadeIn(options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:100

Fade in from invisible.

Parameters

options?

TweenOptions

Returns

Animation

---

fadeOut()

fadeOut(options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:105

Fade out to invisible.

Parameters

options?

TweenOptions

Returns

Animation

---

fadeTo()

fadeTo(opacity, options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:95

Tween opacity to a target value.

Parameters

opacity

number

options?

TweenOptions

Returns

Animation

---

getTransform()

getTransform(): Transform3D

Defined in: packages/core/src/scene/registered-object-3d.ts:52

Current authoring (local) transform.

Returns

Transform3D

---

initialState()

initialState(): RuntimeState

Defined in: packages/core/src/scene/registered-object-3d.ts:62

Baseline runtime state from the authoring transform.

Returns

RuntimeState

---

moveTo()

moveTo(position, options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:75

Tween world position.

Parameters

position

AbsXYZ

options?

TweenOptions

Returns

Animation

---

orientTo()

orientTo(euler, options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:85

Tween orientation from intrinsic XYZ Euler angles (radians).

Parameters

euler

EulerRotation

options?

TweenOptions

Returns

Animation

---

replaceObject()

replaceObject(next): void

Defined in: packages/core/src/scene/registered-object-3d.ts:47

Replace the definition (post-build swap).

Parameters

next

IMObject3D

Returns

void

---

rotateTo()

rotateTo(rotation, options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:80

Tween orientation (quaternion slerp).

Parameters

rotation

Quaternion

options?

TweenOptions

Returns

Animation

---

scaleTo()

scaleTo(scale, options?): Animation

Defined in: packages/core/src/scene/registered-object-3d.ts:90

Tween scale (scalar or per-axis).

Parameters

scale

number | Vec3

options?

TweenOptions

Returns

Animation

---

setTransform()

setTransform(transform): void

Defined in: packages/core/src/scene/registered-object-3d.ts:57

Merge a partial transform into the local transform.

Parameters

transform

Partial<Transform3D>

Returns

void