Interface ITimelineAnimationOverrideExperimental

Interface for receiving callbacks during timeline animation evaluation.
Allows modification of position/rotation values before they are applied.

Registration:

director.registerAnimationCallback(this);
// Later: director.unregisterAnimationCallback(this);

This interface may change in future versions

See

PlayableDirector.registerAnimationCallback

interface ITimelineAnimationOverride {
    onTimelinePosition(
        director: PlayableDirector,
        target: Object3D,
        time: number,
        position: Vector3,
    ): any;
    onTimelineRotation(
        director: PlayableDirector,
        target: Object3D,
        time: number,
        rotation: Quaternion,
    ): any;
}

Methods

onTimelinePosition? onTimelineRotation?

Methods

OptionalonTimelinePosition

  • onTimelinePosition(
        director: PlayableDirector,
        target: Object3D,
        time: number,
        position: Vector3,
    ): any
    Experimental

    Parameters

    • director: PlayableDirector

      The director that is playing the timeline

    • target: Object3D

      The target object that is being animated

    • time: number

      The current time of the timeline

    • position: Vector3

      The evaluated position of the target object at the current time

    Returns any

OptionalonTimelineRotation

  • onTimelineRotation(
        director: PlayableDirector,
        target: Object3D,
        time: number,
        rotation: Quaternion,
    ): any
    Experimental

    Parameters

    • director: PlayableDirector

      The director that is playing the timeline

    • target: Object3D

      The target object that is being animated

    • time: number

      The current time of the timeline

    • rotation: Quaternion

      The evaluated rotation of the target object at the current time

    Returns any

Settings

Member Visibility

On This Page

Methods