Skip to main content

Class: Interactivity

Defined in: modules/engine/src/interactivity/interactivity.ts:128

Deterministic, GPU-independent interpreter for a defined subset of KHR_interactivity. Unsupported operations fail during construction; no graph is silently partially executed. A host supplies application properties through the property adapter.

Constructors​

Constructor​

new Interactivity(definition, options?): Interactivity

Defined in: modules/engine/src/interactivity/interactivity.ts:152

Parameters​

definition​

InteractivityDefinition

options?​

InteractivityOptions = {}

Returns​

Interactivity

Properties​

definition​

readonly definition: InteractivityDefinition

Defined in: modules/engine/src/interactivity/interactivity.ts:132

graph​

readonly graph: InteractivityGraph

Defined in: modules/engine/src/interactivity/interactivity.ts:133

maxSteps​

readonly maxSteps: number

Defined in: modules/engine/src/interactivity/interactivity.ts:136

properties?​

readonly optional properties?: InteractivityPropertyAdapter

Defined in: modules/engine/src/interactivity/interactivity.ts:135

variables​

readonly variables: unknown[][]

Defined in: modules/engine/src/interactivity/interactivity.ts:134

Accessors​

graphCount​

Get Signature​

get graphCount(): number

Defined in: modules/engine/src/interactivity/interactivity.ts:200

Returns​

number

Methods​

evaluate()​

evaluate(index, socket?, visiting?): unknown[]

Defined in: modules/engine/src/interactivity/interactivity.ts:286

Evaluate a pure value socket. Values are component arrays as defined by the extension.

Parameters​

index​

number

socket?​

string = 'value'

visiting?​

Set<number> = ...

Returns​

unknown[]

flushPhysics()​

flushPhysics(): Promise<void>

Defined in: modules/engine/src/interactivity/interactivity.ts:590

Await asynchronous physics query continuations before advancing the next simulation tick.

Returns​

Promise<void>

getGraph()​

getGraph(index): InteractivityGraph

Defined in: modules/engine/src/interactivity/interactivity.ts:204

Parameters​

index​

number

Returns​

InteractivityGraph

getOperation()​

getOperation(graphIndex, nodeIndex): string

Defined in: modules/engine/src/interactivity/interactivity.ts:210

Parameters​

graphIndex​

number

nodeIndex​

number

Returns​

string

notifyPhysicsTrigger()​

notifyPhysicsTrigger(phase, triggerNode, colliderNode, motionNode): void

Defined in: modules/engine/src/interactivity/interactivity.ts:600

Deliver simulation-step sensor events, including multiple events between rendering ticks.

Parameters​

phase​

"enter" | "exit"

triggerNode​

number

colliderNode​

number

motionNode​

number

Returns​

void

selectNode()​

selectNode(nodeIndex): void

Defined in: modules/engine/src/interactivity/interactivity.ts:626

Dispatch selection of one source node; the host owns hit testing and selectability.

Parameters​

nodeIndex​

number

Returns​

void

start()​

start(): void

Defined in: modules/engine/src/interactivity/interactivity.ts:619

Call once after host properties and scene objects are ready.

Returns​

void

tick()​

tick(timeSeconds): void

Defined in: modules/engine/src/interactivity/interactivity.ts:642

Tick with elapsed seconds; the first tick has timeSinceStart=0 and delta=NaN.

Parameters​

timeSeconds​

number

Returns​

void