Class CameraFlightAnimation

constructor

• new CameraFlightAnimation(
      view: View,
      cfg?: { duration: number },
  ): CameraFlightAnimation

  Creates a new CameraFlightAnimation instance.

  Parameters

  • view: View

    The View whose Camera will be animated.
  • Optionalcfg: { duration: number }

    Optional configuration.

    • duration: number

      Default animation duration in seconds for CameraFlightAnimation.flyTo.

  Returns CameraFlightAnimation

Readonlycamera

easing

ReadonlyonCancelled

ReadonlyonStarted

ReadonlyonStopped

Readonlyview

duration

• get duration(): number

  Gets the flight duration in seconds.

  Default value is 0.5.

  Returns number
• set duration(value: number): void

  Sets the flight duration in seconds.

  Stops any flight currently in progress.

  Default value is 0.5.

  Parameters

  • value: number

  Returns void

fit

• get fit(): boolean

  When flying to a SceneModel, ViewObject or boundary, indicates if the CameraFlightAnimation always adjusts the distance of Camera.eye from Camera.look to ensure that the target always fits in view.

  When false, the eye will remain fixed at its current distance from the look position.

  Default value is true.

  Returns boolean
• set fit(value: boolean): void

  When flying to a SceneModel, ViewObject or boundary, indicates if the CameraFlightAnimation always adjusts the distance of Camera.eye from Camera.look to ensure that the target always fits in view.

  When false, the eye will remain fixed at its current distance from the look position.

  Default value is true.

  Parameters

  • value: boolean

  Returns void

fitFOV

• get fitFOV(): number

  Gets how much of the perspective field-of-view, in degrees, that a target ViewObject should fill the canvas when calling CameraFlightAnimation.flyTo or CameraFlightAnimation.jumpTo.

  Default value is 45.

  Returns number
• set fitFOV(value: number): void

  Sets how much of the perspective field-of-view, in degrees, that a target ViewObject should fill the canvas when calling CameraFlightAnimation.flyTo or CameraFlightAnimation.jumpTo.

  Default value is 45.

  Parameters

  • value: number

  Returns void

trail

• get trail(): boolean

  Indicates if this CameraFlightAnimation will orient the Camera in the direction that it is flying.

  Default value is false.

  Returns boolean
• set trail(value: boolean): void

  Indicates if this CameraFlightAnimation will orient the Camera in the direction that it is flying.

  Default value is false.

  Parameters

  • value: boolean

  Returns void

cancel

• cancel(): void

  Cancels a flight in progress, without calling the arrival callback.

  Returns void

flyTo

• flyTo(params?: FlyToParams, callback?: (arg0: any) => void): void

  Animates the camera to a target viewpoint or bounding volume.

  • If a bounding box is provided, the camera will fly to frame the box within the view.
  • If eye, look, and up are provided, the camera will interpolate to that exact pose.

  Parameters

  • params: FlyToParams = {}

    Parameters defining the flight target and behavior.
  • Optionalcallback: (arg0: any) => void

    Optional callback invoked after the flight completes.

  Returns void

jumpTo

• jumpTo(params: any): void

  Instantly moves the camera to a specified viewpoint or bounding volume, without animation.

  • If a bounding box is provided, the camera will immediately frame it in the view.
  • If eye, look, and up are provided, the camera will immediately assume that pose.

  Parameters

  • params: any

    Target camera state or bounding box.

  Returns void

stop

• stop(): void

  Stops an earlier CameraFlightAnimation.flyTo, fires arrival callback, then "stopped" event.

  Returns void