zimporter-html - v1.0.0
    Preparing search index...

    Class ZTimeline

    Frame-based animation container. Works identically to the PIXI version: children are keyed by their instanceName and per-frame transform deltas are written directly to their CSS via ZContainer setters.

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Constructors

    constructor

    Properties

    _fitToScreen _frames _props? children cuePoints currentFrame currentTransform el fixedBoxSize? func interactive interactiveChildren landscape looping originalFontSize? originalTextHeight? originalTextWidth? parent portrait resizeable scale totalFrames stageOffsetX stageOffsetY stageScale

    Accessors

    alpha cursor name pivotX pivotY rotation scaleX scaleY visible x y

    Methods

    addChild addStateEndEventListener applyTransform emit executeFitToScreen get getAll getAllOfType getAlpha getChildAt getChildByName getFrames getProps getTextField getTextStyle getType getVisible gotoAndPlay gotoAndStop init isAnchored off on play reapplyAnchor removeAllListeners removeChild removeChildren removeStateEndEventListener resize setAlpha setCuePoints setFixedBoxSize setFrames setInstanceData setText setTextStyle setVisible stop update

    Constructors

    Properties

    _fitToScreen

    _fitToScreen: boolean = false

    _frames

    _frames: any

    Optional_props

    _props?: any
    children: ZContainer[] = []

    Typed child list (mirrors PIXI's children array).

    cuePoints: Record<number, string> = {}
    currentFrame: number = 0
    currentTransform: OrientationData
    el: HTMLDivElement

    The root div element for this container.

    fixedBoxSize?: boolean
    func: ((self: ZTimeline) => void) | undefined
    interactive: boolean = false
    interactiveChildren: boolean = true
    landscape: OrientationData
    looping: boolean = true
    originalFontSize?: number
    originalTextHeight?: number
    originalTextWidth?: number
    parent: ZContainer | null = null
    portrait: OrientationData
    resizeable: boolean = true
    scale: { x: number; y: number }

    PIXI-compatible scale object. Setting .x / .y delegates to the scaleX / scaleY setters so that ZScene can write stage.scale.x = s exactly as in the PIXI version.

    Initialised in the constructor so this is captured correctly.

    totalFrames: number | undefined
    stageOffsetX: number = 0

    Current CSS-pixel X offset of the stage from the viewport edge.

    stageOffsetY: number = 0

    Current CSS-pixel Y offset of the stage from the viewport edge.

    stageScale: number = 1

    Current uniform CSS scale applied to the stage element.

    Accessors

    • get alpha(): number

      Returns number

    • set alpha(value: number): void

      Parameters

      • value: number

      Returns void

    • get cursor(): string

      Returns string

    • set cursor(value: string): void

      Parameters

      • value: string

      Returns void

    • get name(): string

      Returns string

    • set name(value: string): void

      Parameters

      • value: string

      Returns void

    • get scaleX(): number

      Returns number

    • set scaleX(value: number): void

      Parameters

      • value: number

      Returns void

    • get scaleY(): number

      Returns number

    • set scaleY(value: number): void

      Parameters

      • value: number

      Returns void

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get y(): number

      Returns number

    • set y(value: number): void

      Parameters

      • value: number

      Returns void

    Methods

    • Stretches this container to visually cover the entire browser viewport. Mirrors PIXI's executeFitToScreen — positions the container at the viewport's top-left (expressed in stage / scene-unit coords) and scales the first child image element to fill the viewport dimensions.

      Parameters

      • viewportW: number

        Current browser viewport width in CSS pixels.

      • viewportH: number

        Current browser viewport height in CSS pixels.

      • stageOffsetX: number

        CSS-pixel X offset of the scaled stage from the viewport edge.

      • stageOffsetY: number

        CSS-pixel Y offset of the scaled stage from the viewport edge.

      • stageScale: number

        Uniform CSS scale applied to the stage.

      Returns void

    • Finds the first text element (a <span class="z-text">) among children. Mirrors PIXI's getTextField().

      Returns HTMLElement | null

    • Parameters

      • frameNum: number

      Returns void

    • Parameters

      • frameNum: number

      Returns void

    • Called once all children have been added. Captures original text dimensions.

      Returns void

    • Parameters

      • event: string
      • listener: Function

      Returns this

    • Parameters

      • event: string
      • listener: Function

      Returns this

    • Public entry point for ZScene to re-run the anchor computation after all containers in the resize map have been updated to the new orientation. This guarantees that ancestor _x / _y values are current when chain inversion runs.

      Returns void

    • Parameters

      • width: number
      • height: number
      • orientation: "portrait" | "landscape"

      Returns void

    • Parameters

      • cuePoints: Record<number, string>

      Returns void

    • Parameters

      • value: any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods