Class AnimationClip

Contains animation curves for translation/rotation/scale of scene objects/skeleton bones, as well as curves for generic property animation.

Hierarchy (view full)

Constructors

constructor

Accessors

curves events handle hasRootMotion isAdditive isDestroyed length metaData name rootMotion sampleRate uuid

Methods

duplicate makeAdditive onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart rescaleToTime revert unload

Constructors

constructor

  • new AnimationClip(options?, isInternalConstructor?): AnimationClip

  • Creates an animation clip with no curves. After creation make sure to register some animation curves before using it.

    Parameters

    • Optionaloptions: {
          isAdditive?: boolean;
      } | {
          curves: AnimationCurves;
          isAdditive?: boolean;
          rootMotion?: RootMotion;
          sampleRate?: number;
      }

      Options object for the function call.

    • OptionalisInternalConstructor: boolean

    Returns AnimationClip

Accessors

curves

  • get curves(): AnimationCurves

  • A set of all curves stored in the animation. Returned value will not be updated if the animation clip curves are added or removed, as it is a copy of clip's internal values.

    Returns AnimationCurves

  • set curves(value): void

  • Parameters

    Returns void

events

handle

hasRootMotion

  • get hasRootMotion(): boolean

  • Checks if animation clip has root motion curves separate from the normal animation curves.

    Returns boolean

isAdditive

  • get isAdditive(): boolean

  • Checks are the curves contained within the clip additive. Additive clips are intended to be added on top of other clips.

    Returns boolean

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

length

  • get length(): number

  • Returns the length of the animation clip, in seconds.

    Returns number

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

rootMotion

  • get rootMotion(): RootMotion

  • Returns a set of curves containing motion of the root bone. This allows the user to evaluate the root bone animation curves manually, instead of through the normal animation process. This property is only available if animation clip was imported with root motion import enabled.

    Returns RootMotion

sampleRate

  • get sampleRate(): number

  • Number of samples per second the animation clip curves were sampled at. This value is not used by the animation clip or curves directly since unevenly spaced keyframes are supported. But it can be of value when determining the original sample rate of an imported animation or similar.

    Returns number

  • set sampleRate(value): void

  • Parameters

    • value: number

    Returns void

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

makeAdditive

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

rescaleToTime

  • rescaleToTime(newLength): boolean

  • Rescales the animation clip and all it's curves to match the specified length in seconds.

    Parameters

    • newLength: number

    Returns boolean

    true upon success.

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods