Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Animation

简单动画组件，具备简单的动画播放、暂停功能。

export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

autoPlay

autoPlay: boolean = false

初次被加载到场景上时是否自动播放，如果开启此选项，组件将在初次被加载到场景上时播放默认播放的动画名所对应的动画。

bindAnimationClipOnNeed

bindAnimationClipOnNeed: boolean = false

是否进行动态动画绑定，对于动画数目特别多的使用场景会降低初始化的耗时。

clips

clips: {} = ...

组件所控制的动画集，运行时直接更改此对象内容需要手动调用rebind方法。

Type declaration

Readonly entity

entity: Entity3D

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

speed

speed: number = 1

组件播放动画的速度。

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

  • Align: number
  • Layout: number
  • Low: number
  • Physics: number
  • Render: number
  • Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

    • (...args: any[]): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

  • get active(): boolean
  • set active(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean

  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

clip

  • get clip(): string

  • 组件初始化时默认播放的动画名称。

    Returns string

isPlaying

  • get isPlaying(): boolean

  • 组件是否有

    Returns boolean

mode

  • 组件的播放模式。

    Returns WrapMode

playingClip

  • get playingClip(): string

  • 正在播放的动画名称。

    Returns string

skeleton

  • 动画组件所控制的骨骼。

    Returns Skeleton

  • 动画组件所控制的骨骼。

    Parameters

    Returns void

time

  • get time(): number

  • 动画播放的时长。

    Returns number

Methods

addClip

  • 添加动画。

    Parameters

    Returns void

destroy

  • destroy(): void

  • Returns void

getClip

  • 获取名称对应的动画资源。

    Parameters

    • name: string

      动画名称

    Returns AnimationClip

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean

  • Returns boolean

pause

  • pause(): void

  • 暂停动画播放。

    Returns void

play

  • play(name?: string, time?: number, mode?: WrapMode): void

  • 播放指定动画。

    Parameters

    • Optional name: string

      动画名称

    • time: number = 0

      初始偏移时长

    • Optional mode: WrapMode

      播放方式

    Returns void

rebind

  • rebind(): void

  • 重新绑定骨骼与动画。

    Returns void

removeClip

  • removeClip(name: string): void

  • 删除动画。

    Parameters

    • name: string

      动画名称

    Returns void

resetProperties

  • resetProperties(): void

resume

  • resume(): void

  • 恢复动画播放。

    Returns void

stop

  • stop(): void

  • 停止动画播放。

    Returns void

update

  • update(dt: number): void

  • Parameters

    • dt: number

    Returns void

writeDefaults

  • writeDefaults(): void

  • 重置骨骼节点位置。

    Returns void

Generated using TypeDoc