Class InterpolatingBehavior<C>

constructor

• new InterpolatingBehavior<C extends Camera = Camera>(): InterpolatingBehavior<C>

  Initializes the behavior

  Type Parameters

  • C extends Camera = Camera

  Returns InterpolatingBehavior<C>

easingFunction

easingMode

transitionDuration

attachedNode

• get attachedNode(): Nullable<C>

  Attached node of this behavior

  Returns Nullable<C>

isInterpolating

• get isInterpolating(): boolean

  Returns boolean

name

• get name(): string

  Gets the name of the behavior.

  Returns string

remainingDurationMs

• get remainingDurationMs(): number

  Gets the longest remaining duration (in milliseconds) across all in-flight property animations. Returns 0 when nothing is currently animating.

  Returns number

animatePropertiesAsync

• animatePropertiesAsync<K extends string | number | symbol>(
      properties: Map<K, AllowedAnimValue>,
      transitionDuration?: number,
      easingFn?: EasingFunction,
      updateAnimation?: (key: string, animation: Animation) => void,
  ): Promise<void>

  Animates camera properties to new values.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • properties: Map<K, AllowedAnimValue>

    defines the property values to animate to

  • transitionDuration: number = ...

    defines the transition duration in milliseconds

  • easingFn: EasingFunction = ...

    defines the easing function to use

  • OptionalupdateAnimation: (key: string, animation: Animation) => void

    defines an optional callback used to update each generated animation

  Returns Promise<void>

  a promise that resolves when the animation completes

attach

• attach(camera: C): void

  Attaches the behavior to a camera

  Parameters

  • camera: C

    The camera to attach to

  Returns void

detach

• detach(): void

  Detaches the behavior from the camera

  Returns void

init

• init(): void

  Initializes the behavior

  Returns void

stopAllAnimations

• stopAllAnimations(): void

  Stops and removes all animations

  Returns void

updateProperties

• updateProperties<K extends string | number | symbol>(
      properties: Map<K, AllowedAnimValue>,
  ): void

  Redirects any in-flight transition toward the given property values, reusing the time remaining in the current transition. No-op when nothing is currently animating.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • properties: Map<K, AllowedAnimValue>

    defines the property values to redirect toward

  Returns void

  Deprecated

  Prefer animatePropertiesAsync(properties, remainingDurationMs), which makes the duration explicit. This method is retained for backward compatibility.