Class AnimationSet

constructor

• new AnimationSet(...animations: WebaniCollectionAnimation[]): AnimationSet

  Creates a new AnimationSet instance. Initializes with a set of animations that will be managed and played in the set.

  Parameters

  • ...animations: WebaniCollectionAnimation[]

    The initial animations to be included in the set.

  Returns AnimationSet

animations

nextIsAsynchronous

duration

• get duration(): number

  Gets the total duration of all animations in the set. This is the sum of the durations of all the animations.

  Returns number

  The total duration of the animation set.

last

• get last(): WebaniCollectionAnimation

  Gets the last animation in the set.

  Returns WebaniCollectionAnimation

  The last animation in the set.

length

• get length(): number

  Gets the total number of animations in the set.

  Returns number

  The length of the animation set.

addAnimation

• addAnimation(animation: WebaniCollectionAnimation, asynchronous?: boolean): void

  Adds a new animation to the set. The animation can either be synchronous or asynchronous. If the next animation is asynchronous, it will be appended after the last animation. If it is not asynchronous, it will play immediately after the current animation ends.

  Parameters

  • animation: WebaniCollectionAnimation

    The animation to add.
  • Optionalasynchronous: boolean = true

    Whether the animation should be added asynchronously.

  Returns void

done

• done(t: number): boolean

  Determines if the animation set is done based on the current time.

  Parameters

  • t: number

    The current time of the animation.

  Returns boolean

  true if the animation set is done, false otherwise.

frame

• frame(t: number): WebaniTransformable

  Gets the current frame of the animation set based on the given time. The method finds the appropriate animation to play based on the time t.

  Parameters

  • t: number

    The current time of the animation.

  Returns WebaniTransformable

  The transformed object at the current frame.

onAnimationAdded

• onAnimationAdded<T extends WebaniTransformable>(
      handler: (
          animation: WebaniInterpolatedAnimation<T>,
          asynchronous: boolean,
      ) => void,
  ): void

  Registers a handler that will be called whenever an animation is added to the set. The handler receives the added animation and whether it is asynchronous.

  Type Parameters

  • T extends WebaniTransformable

  Parameters

  • handler: (animation: WebaniInterpolatedAnimation<T>, asynchronous: boolean) => void

    The handler to be called when an animation is added.

  Returns void

setDefaultObject

• setDefaultObject(object: WebaniTransformable): void

  Sets the default object for the animation set. This object is used if no specific object is provided for an animation.

  Parameters

  • object: WebaniTransformable

    The default object to be used in animations.

  Returns void