Strata - v1.4.10
    Preparing search index...

    Interface AnimatedBillboardProps

    Props for the AnimatedBillboard component.

    interface AnimatedBillboardProps {
        alphaTest?: number;
        autoPlay?: boolean;
        children?: ReactNode;
        color?: ColorRepresentation;
        columns: number;
        depthWrite?: boolean;
        frameCount?: number;
        frameRate?: number;
        lockY?: boolean;
        loop?: boolean;
        onAnimationComplete?: () => void;
        opacity?: number;
        pingPong?: boolean;
        position?: [number, number, number] | Vector3;
        renderOrder?: number;
        rows: number;
        size?: number | [number, number];
        texture: Texture;
        transparent?: boolean;
    }

    Hierarchy

    Index

    Properties

    alphaTest? autoPlay? children? color? columns depthWrite? frameCount? frameRate? lockY? loop? onAnimationComplete? opacity? pingPong? position? renderOrder? rows size? texture transparent?

    Properties

    alphaTest?: number

    Alpha test threshold for transparency. Default: 0.1.

    autoPlay?: boolean

    Start playing immediately on mount. Default: true.

    children?: ReactNode

    Optional child elements to be billboarded.

    color?: ColorRepresentation

    Tint color for the billboard. Default: 0xffffff.

    columns: number

    Number of columns in the sprite sheet.

    depthWrite?: boolean

    Whether to write to the depth buffer. Default: false.

    frameCount?: number

    Total number of frames. Defaults to columns * rows.

    frameRate?: number

    Playback speed in frames per second. Default: 10.

    lockY?: boolean

    Lock Y-axis rotation (cylindrical billboard). Default: false.

    loop?: boolean

    Whether the animation loops. Default: true.

    onAnimationComplete?: () => void

    Callback fired when a non-looping animation finishes.

    opacity?: number

    Opacity (0-1). Default: 1.

    pingPong?: boolean

    Play forward then backward. Default: false.

    position?: [number, number, number] | Vector3

    World position of the billboard. Default: [0, 0, 0].

    renderOrder?: number

    Render order for transparency sorting. Default: 0.

    rows: number

    Number of rows in the sprite sheet.

    size?: number | [number, number]

    Size of the billboard (single number or [width, height]). Default: 1.

    texture: Texture

    Sprite sheet texture.

    transparent?: boolean

    Whether to enable transparency. Default: true.

    Settings

    Member Visibility

    On This Page

    Properties