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

    Class ZButton

    HTML div–based display object that mirrors the ZContainer interface from the PIXI and Phaser versions of zImporter.

    Each ZContainer owns a single HTMLDivElement (el).
    The element is position:absolute; left:0; top:0; width:0; height:0; overflow:visible so that children are positioned relative to its (0,0) origin and the CSS transform maps 1-to-1 to PIXI's transform model:

    T(x, y) · R(rotation) · S(scaleX, scaleY) · T(-pivotX, -pivotY)

    This is identical to how PIXI.Container resolves world coordinates.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _fitToScreen: boolean = false
    _props?: any
    children: ZContainer[] = []

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

    currentTransform: OrientationData
    disabledLabelContainer: ZContainer
    disabledLabelContainer2: ZContainer
    disabledState: ZContainer
    downLabelContainer: ZContainer
    downLabelContainer2: ZContainer
    downState: ZContainer
    el: HTMLDivElement

    The root div element for this container.

    fixedBoxSize?: boolean
    interactive: boolean = false
    interactiveChildren: boolean = true
    landscape: OrientationData
    longPressCallback?: () => void
    originalFontSize?: number
    originalTextHeight?: number
    originalTextWidth?: number
    overLabelContainer: ZContainer
    overLabelContainer2: ZContainer
    overState: ZContainer
    parent: ZContainer | null = null
    portrait: OrientationData
    pressCallback?: () => void
    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.

    topLabelContainer: ZContainer
    topLabelContainer2: ZContainer
    upLabelContainer: ZContainer
    upLabelContainer2: ZContainer
    upState: ZContainer
    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

    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

    • Returns HTMLElement | null

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

      Returns HTMLElement | null

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

      Parameters

      • _labelStr: string = ''

      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

      • fixed: boolean

      Returns void

    • Parameters

      • name: string

      Returns void

    • Parameters

      • name: string

      Returns void