API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
classSceneTransition
@codexo/exojs / core / stable
Reusable, immutable transition definition - construct once, use across arbitrarily many navigations (even concurrently, across multiple `Application`s). All per-navigation mutable state lives on the SceneTransitionSession a call to SceneTransition.beginSession produces, never on the definition itself.
0
props
3
methods
0
events
Import
import { SceneTransition } from '@codexo/exojs'Reusable, immutable transition definition - construct once, use across arbitrarily many navigations (even concurrently, across multiple `Application`s). All per-navigation mutable state lives on the SceneTransitionSession a call to SceneTransition.beginSession produces, never on the definition itself.
Constructors1
new(): SceneTransitionMethods3
beginSession(environment: SceneTransitionEnvironmentHanded to SceneTransition.beginSession. `commitRequested`/`committed` are live views - they reflect state at read time, not a snapshot taken when this object w…): SceneTransitionSessionOne navigation's worth of mutable transition state - created fresh per navigation by SceneTransition.beginSession, driven by the Director until SceneTransition…Called by the Director - do not call directly. Dispatches to SceneTransition.createSession, which is protected so it does not clutter a beginner's view of a transition subclass while still being callable from Director code that does not share this class's hierarchy.
createSession(environment: SceneTransitionEnvironmentHanded to SceneTransition.beginSession. `commitRequested`/`committed` are live views - they reflect state at read time, not a snapshot taken when this object w…): SceneTransitionSessionOne navigation's worth of mutable transition state - created fresh per navigation by SceneTransition.beginSession, driven by the Director until SceneTransition…Construct this navigation's session. Override in a subclass.
getRequirements(context: SceneTransitionContextImmutable, read-only description of the navigation a SceneTransition is being asked to run for - passed to SceneTransition.getRequirements and into the SceneTr…): SceneTransitionRequirementsRender resources a SceneTransitionSession needs, declared once up front via SceneTransition.getRequirements so the Director can provision them before the sessi…Pure, synchronous. Called once, before a session starts, so the Director can provision render resources up front.
Source