interface FlyToParams {
    aabb?: AABB3;
    arc?: boolean;
    arcHeight?: number;
    duration?: number;
    easing?: boolean | "inThenOut";
    eye?: Vec3;
    fitFOV?: number;
    length?: number;
    look?: Vec3;
    orthoScale?: number;
    poi?: Vec3;
    projection?: number;
    up?: Vec3;
}

Properties

aabb?: AABB3

Target axis-aligned bounding box (AABB) in world coordinates for the camera to focus on.

arc?: boolean

When true, the camera follows an arc from eye1 to eye2 instead of a straight line — rising at the midpoint of the flight to give a sense of travelling over the scene. The apex height is controlled by arcHeight (or auto-derived from the eye distance). The look point still interpolates linearly so the focus tracks naturally; only the eye position picks up the parabolic offset.

Only takes effect on flights that move the eye — i.e. AABB-fit flights and {eye, look, up} flights. Pure look-only or eye-only rotations ignore it.

arcHeight?: number

When arc is set, the apex height in metres along the arc-up axis (the world-up component perpendicular to the chord eye2 - eye1). Defaults to 0.25 × the eye-to-eye distance, so flights of any scale produce a visually similar arc.

duration?: number

Duration of the animation in seconds.

easing?: boolean | "inThenOut"

Easing curve for this flight, overriding the per-instance CameraFlightAnimation.easing field for the duration of this call:

  • true (or omitted) — the default quadratic ease-out: starts at full velocity and decelerates to a stop on arrival.
  • "inThenOut" — piecewise quadratic ease-in then ease-out (2t² on [0, 0.5], 1 − 2(1−t)² on [0.5, 1]). The camera leaves and arrives at zero velocity, accelerating at a constant rate up to the midpoint and decelerating at a constant rate down to the target — i.e. a triangular speed profile peaking at t=0.5.
  • false — no easing; constant velocity along the path.
eye?: Vec3

Target position for the camera eye.

fitFOV?: number

In perspective projection mode, defines how much of the field-of-view the bounding volume should occupy upon arrival. Expressed in degrees.

length?: number

Target distance between the camera and its point-of-interest.

look?: Vec3

Target position for the camera to look at.

orthoScale?: number

Target orthographic scale, used when transitioning to an orthographic projection.

poi?: Vec3

Optional point-of-interest in world coordinates for the camera to focus on.

projection?: number

Specifies the projection type to transition to. Use either PerspectiveProjectionType or OrthoProjectionType.

up?: Vec3

Target "up" vector for the camera orientation.