Intermact API Reference / @intermact/core / RegisteredObject2D
Class: RegisteredObject2D
Defined in: packages/core/src/scene/registered-object.ts:66
A 2D object registered into a Scene (design.md §9.2). It is the main target of animation: its factory methods return Animation handles (data) without executing. M1 implements tween-based motion (move/rotate/scale + generic tween); Create/Fade reveal semantics and updaters/interaction arrive in later milestones (M4/M6/M11).
Extended by
Constructors
Constructor
new RegisteredObject2D(
id,object,transform,reactive?,defHost?):RegisteredObject2D
Defined in: packages/core/src/scene/registered-object.ts:76
Parameters
id
string
object
transform
reactive?
UpdaterHost | null
defHost?
DefinitionHost | null
Returns
RegisteredObject2D
Properties
id
readonlyid:string
Defined in: packages/core/src/scene/registered-object.ts:77
layout
layout:
LayoutHandle
Defined in: packages/core/src/scene/registered-object.ts:71
RectTransform-/Manim-style layout (design.md §9.4); set by the Scene.
object
object:
IMObject2D
Defined in: packages/core/src/scene/registered-object.ts:68
Current immutable object definition (design.md §9.2).
parentId?
optionalparentId?:string
Defined in: packages/core/src/scene/registered-object.ts:74
Parent in the transform hierarchy (design.md §9.3), if any.
Methods
addUpdater()
addUpdater(
fn): () =>void
Defined in: packages/core/src/scene/registered-object.ts:92
Per-frame updater (design.md §8.2); returns an unsubscribe function.
Parameters
fn
Returns
() => void
create()
create(
options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:153
Create: draw the object on (stroke trim, then fill reveal). Baseline hidden state is applied when this animation is played into the Storyboard (§11).
Parameters
options?
Returns
fadeIn()
fadeIn(
options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:140
Fade in from invisible: baseline opacity 0 is applied when this is played (§11).
Parameters
options?
Returns
fadeOut()
fadeOut(
options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:145
Fade out to invisible.
Parameters
options?
Returns
fadeTo()
fadeTo(
opacity,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:135
Tween opacity to a target value.
Parameters
opacity
number
options?
Returns
getTransform()
getTransform():
Transform2D
Defined in: packages/core/src/scene/registered-object.ts:100
Current authoring (local) transform.
Returns
initialState()
initialState():
RuntimeState2D
Defined in: packages/core/src/scene/registered-object.ts:110
Baseline runtime state derived from the authoring transform.
Returns
morphTo()
morphTo(
target,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:183
Morph: transform this object's geometry toward target (design.md §11.4). Strategy defaults to arc-length; pass strategy: "matching" (or use transformMatchingTo) for part-keyed composite morphs.
Parameters
target
options?
Returns
moveTo()
moveTo(
position,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:120
Tween world position.
Parameters
position
options?
Returns
on()
on(
binding,pick?):this
Defined in: packages/core/src/scene/registered-object.ts:198
Attach pointer/drag handlers (design.md §12.2). Adds (or replaces) an InteractiveTrait carrying the binding and a pick proxy (defaults to the object's bounds rect), propagating the new definition so the renderer sees it. Returns this for chaining.
Parameters
binding
pick?
Returns
this
replaceObject()
replaceObject(
next):void
Defined in: packages/core/src/scene/registered-object.ts:87
Replace the definition (reactive rebuild or post-morph swap).
Parameters
next
Returns
void
rotateTo()
rotateTo(
rotation,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:125
Tween rotation (radians).
Parameters
rotation
number
options?
Returns
scaleTo()
scaleTo(
scale,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:130
Tween scale (scalar or per-axis).
Parameters
scale
number | Vec2
options?
Returns
setTransform()
setTransform(
transform):void
Defined in: packages/core/src/scene/registered-object.ts:105
Merge a partial transform into the local transform.
Parameters
transform
Partial<Transform2D>
Returns
void
transformMatchingTo()
transformMatchingTo(
target,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:188
Part-aware morph (transformer/remover/introducer) toward a composite target.
Parameters
target
options?
Returns
tween()
tween(
property,to,options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:115
Tween an addressable runtime property to a target value.
Parameters
property
to
unknown
options?
Returns
write()
write(
options?):Animation
Defined in: packages/core/src/scene/registered-object.ts:171
Write: sequential left-to-right glyph stroke reveal for text/LaTeX (design.md §13). Sugar over create with stroke.direction: "ltr" and optional stroke.glyphOverlap (negative padding between glyphs).