Luxar Viewer API Documentation - v2026.10.19
    Preparing search index...

    Interface ZarrWaypoint

    A camera pose bound to a hidden-dimension position (Python Waypoint). First match in list order wins; see core/app/camera/waypoint-driver.ts.

    interface ZarrWaypoint {
        when: ZarrWaypointCondition;
        camera: ZarrCameraConfig;
        duration_ms?: number;
        easing?: "linear" | "ease-in-out" | "smooth" | "cruise";
        trajectory?: ZarrTrajectoryKind | ZarrTrajectory;
        speed?: number;
        duration_range_ms?: [number, number];
        rendering?: Record<string, unknown>;
        reveal?: "immediate" | "on_arrival";
    }
    Index
    when camera duration_ms? easing? trajectory? speed? duration_range_ms? rendering? reveal?
    when: ZarrWaypointCondition
    camera: ZarrCameraConfig
    duration_ms?: number

    Flight duration in ms; absent = viewer default, 0 = snap.

    easing?: "linear" | "ease-in-out" | "smooth" | "cruise"

    ease-in-out (smoothstep, default), smooth (smootherstep), cruise or linear.

    trajectory?: ZarrTrajectoryKind | ZarrTrajectory

    The flight path (Python luxar.core.trajectories): a name for a trajectory's defaults, or an object carrying its parameters. See core/app/camera/flight-trajectories.ts for what each does.

    speed?: number

    Pace the flight: duration = path length / speed (units per second).

    duration_range_ms?: [number, number]

    [min, max] duration of a paced flight, ms.

    rendering?: Record<string, unknown>

    Rendering overrides (snake_case ViewerConfig keys) applied on arrival.

    reveal?: "immediate" | "on_arrival"

    When this waypoint's dimension-bound overlays appear. immediate (the default) shows them as the dimension changes, while the camera is still flying; on_arrival holds overlays that would newly appear until the flight resolves — a snap or a camera-less waypoint arrives at once, a flight the visitor cancels counts as arrival, a flight a newer waypoint supersedes never reveals. Departing overlays hide immediately either way.

    Settings
    Member Visibility

    On This Page
    Properties