Class CameraFlightAnimation

constructor

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

• Creates a new CameraFlightAnimation

  Parameters

  • view: View
  • Optionalcfg: { duration: number }

    • duration: number

      Animation duration in seconds when using 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?: {
          aabb?: FloatArrayParam;
          duration?: number;
          eye?: FloatArrayParam;
          fitFOV?: number;
          length?: number;
          look?: FloatArrayParam;
          orthoScale?: number;
          poi?: FloatArrayParam;
          projection?: number;
          up?: FloatArrayParam;
      },
      callback?: (arg0: any) => void,
  ): void

• Flies the Camera to a target.

  • When the target is a boundary, the Camera will fly towards the target and stop when the target fills most of the canvas.
  • When the target is an explicit Camera position, given as eye, look and up, then CameraFlightAnimation will interpolate the Camera to that target and stop there.

  Parameters

  • Optionalparams: {
        aabb?: FloatArrayParam;
        duration?: number;
        eye?: FloatArrayParam;
        fitFOV?: number;
        length?: number;
        look?: FloatArrayParam;
        orthoScale?: number;
        poi?: FloatArrayParam;
        projection?: number;
        up?: FloatArrayParam;
    } = {}

    Either a parameters object or a Component subtype that has an AABB. Defaults to the Scene, which causes the Camera to fit the Scene in view.

    • Optionalaabb?: FloatArrayParam

      World-space axis-aligned bounding box (AABB) target to fly to.

    • Optionalduration?: number

      Flight duration in seconds. Overrides CameraFlightAnimation.duration.

    • Optionaleye?: FloatArrayParam

      Position to fly the eye position to.

    • OptionalfitFOV?: number

      How much of field-of-view, in degrees, that a target ViewObject or its AABB should fill the canvas on arrival. Overrides CameraFlightAnimation.fitFOV.

    • Optionallength?: number

    • Optionallook?: FloatArrayParam

      Position to fly the look position to.

    • OptionalorthoScale?: number

      Animate the Camera's orthographic scale to this target value. See OrthoProjection.scale.

    • Optionalpoi?: FloatArrayParam

    • Optionalprojection?: number

      Projection type to transition into as we fly. Can be any of the values of Camera.projectionType | Camera.projectionType.

    • Optionalup?: FloatArrayParam

      Position to fly the up vector to.
  • Optionalcallback: (arg0: any) => void

    Callback fired on arrival.

  Returns void

jumpTo

• jumpTo(params: any): void

• Jumps the Camera to the given target.

  • When the target is a boundary, this CameraFlightAnimation will position the Camera at where the target fills most of the canvas.
  • When the target is an explicit Camera position, given as eye, look and up vectors, then this CameraFlightAnimation will jump the Camera to that target.

  Parameters

  • params: any

    Either a parameters object or a Component subtype that has a World-space AABB.

  Returns void

stop

• stop(): void

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

  Returns void