Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SkeletalAnimation

骨骼动画组件,在普通动画组件基础上额外提供以下功能:

  • 可选预烘焙动画模式或实时计算模式,用以权衡运行时效率与效果;
  • 提供骨骼挂点功能:通过在动画根节点下创建挂点节点,并在骨骼动画组件上配置 socket 列表,挂点节点的 Transform 就能与骨骼保持同步。

Hierarchy

Index

Properties

Protected _clips

_clips: (null | AnimationClip)[] = []

Protected _crossFade

_crossFade: CrossFade = new CrossFade()

Protected _defaultClip

_defaultClip: AnimationClip | null = null

Protected _nameToState

_nameToState: Record<string, AnimationState> = createMap(true)

Protected _sockets

_sockets: Socket[] = []

Protected _useBakedAnimation

_useBakedAnimation: boolean = true

playOnLoad

playOnLoad: boolean = false

是否在组件开始运行时自动播放默认剪辑。 注意,若在组件开始运行前调用了 crossFadeplay(),此字段将不会生效。

Static EventType

EventType: EnumAlias<typeof EventType> = EventType

Static Socket

Socket: Socket = Socket

Accessors

clips

defaultClip

sockets

useBakedAnimation

  • get useBakedAnimation(): boolean
  • set useBakedAnimation(val: boolean): void
  • 是否使用预烘焙动画,默认启用,可以大幅提高运行效时率,但所有动画效果会被彻底固定,不支持任何形式的编辑和混合。
    运行时动态修改此选项会在播放下一条动画片段时生效。

    Returns boolean

  • 是否使用预烘焙动画,默认启用,可以大幅提高运行效时率,但所有动画效果会被彻底固定,不支持任何形式的编辑和混合。
    运行时动态修改此选项会在播放下一条动画片段时生效。

    Parameters

    • val: boolean

    Returns void

Methods

Protected createState

Protected doCreateState

addClip

createSocket

  • createSocket(path: string): null | Node

createState

crossFade

  • crossFade(name: string, duration?: number): void
  • en

    Smoothly switch to play specified animation state.

    zn

    平滑地切换到指定动画状态。

    Parameters

    • name: string

      The name of the animation to switch to

    • Default value duration: number = 0.3

      The duration of the cross fade, default value is 0.3s

    Returns void

getAnimationState

getState

off

  • off(type: EventType, callback?: undefined | ((...any: any[]) => void), thisArg?: any): void
  • 取消注册动画事件回调。

    example
    // unregister event to all animation
    animation.off('play', this.onPlay, this);

    Parameters

    • type: EventType

      The event type to unregister

    • Optional callback: undefined | ((...any: any[]) => void)

      The callback to unregister

    • Optional thisArg: any

    Returns void

on

  • on<TFunction>(type: EventType, callback: TFunction, thisArg?: any, once?: undefined | false | true): any
  • 注册动画事件回调。 回调的事件里将会附上发送事件的 AnimationState。 当播放一个动画时,会自动将事件注册到对应的 AnimationState 上,停止播放时会将事件从这个 AnimationState 上取消注册。

    example
    onPlay: function (type, state) {
        // callback
    }
    // register event to all animation
    animation.on('play', this.onPlay, this);

    Type parameters

    • TFunction: (...any: any[]) => void

    Parameters

    • type: EventType

      The event type to listen to

    • callback: TFunction

      The callback when event triggered

    • Optional thisArg: any
    • Optional once: undefined | false | true

    Returns any

    The registered callback

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

onLoad

  • onLoad(): void

once

  • once<TFunction>(type: EventType, callback: TFunction, thisArg?: any): any

pause

  • pause(): void

play

  • play(name?: undefined | string): void

querySockets

  • querySockets(): string[]

rebuildSocketAnimations

  • rebuildSocketAnimations(): void

removeClip

  • removeClip(clip: AnimationClip, force?: undefined | false | true): void
  • 从动画列表中移除指定的动画剪辑,
    如果依赖于 clip 的 AnimationState 正在播放或者 clip 是 defaultClip 的话,默认是不会删除 clip 的。
    但是如果 force 参数为 true,则会强制停止该动画,然后移除该动画剪辑和相关的动画。这时候如果 clip 是 defaultClip,defaultClip 将会被重置为 null。

    deprecated

    please use removeState

    Parameters

    • clip: AnimationClip
    • Optional force: undefined | false | true

      If force is true, then will always remove the clip and any animation states based on it.

    Returns void

removeState

  • removeState(name: string): void

resume

  • resume(): void

start

  • start(): void

stop

  • stop(): void

Generated using TypeDoc