Class Animation

动画类

Hierarchy (View Summary)

EventDispatcher
- Animation

Index

Constructors

Constructors

constructor

new Animation(params?: AnimationParameters): Animation
Parameters
- params: AnimationParameters = {}
  创建对象的属性参数。可包含此类的所有属性。
Returns Animation
Overrides EventDispatcher.constructor
- Defined in animation/Animation.ts:121

Properties

_listeners

_listeners: ListenerMap | null = null

className

className: string = 'Animation'

clipEndTime

clipEndTime: number = 0

动画整体的最大时间，初始化后会根据 AnimationStates 来自动获取

clips

clips: Record<string, AnimationClip | null> = {}

clipStartTime

clipStartTime: number = 0

动画整体的最小时间，初始化后会根据 AnimationStates 来自动获取

currentLoopCount

currentLoopCount: number = 0

动画当前播放次数

currentTime

currentTime: number = 0

动画当前时间

endTime

endTime: number = 0

动画结束时间，初始化后会根据 AnimationStates 来自动获取，也可以通过 play 来改变

`Readonly`id

id: string

isAnimation

isAnimation: boolean = true

loop

loop: number = Infinity

动画需要播放的次数，默认值为 Infinity 表示永远循环

nodeNameMap

nodeNameMap: Record<string, Node> = {}

paused

paused: boolean = false

动画是否暂停

startTime

startTime: number = 0

动画开始时间

timeScale

timeScale: number = 1

动画播放速度

validAnimationIds

validAnimationIds: Readonly<Record<string, boolean>> | null = null

AnimationId集合

`Static` `Readonly`_anims

_anims: Animation[] = []

Accessors

animStatesList

get animStatesList(): AnimationStates[]
动画状态列表

Returns AnimationStates[]
- Defined in animation/Animation.ts:104
set animStatesList(value: AnimationStates[]): void
动画状态列表
Parameters
- value: AnimationStates[]
Returns void
- Defined in animation/Animation.ts:110

rootNode

get rootNode(): Node | null
动画根节点，不指定根节点将无法正常播放动画

Returns Node | null
- Defined in animation/Animation.ts:90
set rootNode(value: Node | null): void
动画根节点，不指定根节点将无法正常播放动画
Parameters
- value: Node | null
Returns void
- Defined in animation/Animation.ts:96

Methods

_initNodeNameMap

_initNodeNameMap(): void
初始化 node name map

Returns void
- Defined in animation/Animation.ts:182

addClip

addClip(
    name: string,
    start: number,
    end: number,
    animStatesList: AnimationStates[],
): void
添加动画剪辑
Parameters
- name: string
  剪辑名字
- start: number
  动画开始时间
- end: number
  动画结束时间
- animStatesList: AnimationStates[]
  动画帧列表
Returns void
- Defined in animation/Animation.ts:136

clone

clone(rootNode: Node): Animation
clone动画
Parameters
- rootNode: Node
  目标动画根节点
Returns Animation
clone的动画对象
- Defined in animation/Animation.ts:291

fire

fire(typeOrEvent?: string | DispatchEvent, detail?: unknown): boolean
Parameters
- OptionaltypeOrEvent: string | DispatchEvent
- Optionaldetail: unknown
Returns boolean
Inherited from EventDispatcher.fire
- Defined in core/EventDispatcher.ts:79

getAnimStatesListTimeInfo

getAnimStatesListTimeInfo(animStatesList: AnimationStates[]): AnimationTimeRange
获取动画列表的时间信息
Parameters
- animStatesList: AnimationStates[]
  动画列表
Returns AnimationTimeRange
result { startTime, endTime } 时间信息
- Defined in animation/Animation.ts:155

off

off(type?: string, listener?: EventListener<DispatchEvent>): this
Parameters
- Optionaltype: string
- Optionallistener: EventListener<DispatchEvent>
Returns this
Inherited from EventDispatcher.off
- Defined in core/EventDispatcher.ts:60

on

on(type: string, listener: EventListener, once?: boolean): this
Parameters
- type: string
- listener: EventListener
- once: boolean = false
Returns this
Inherited from EventDispatcher.on
- Defined in core/EventDispatcher.ts:48

pause

pause(): void
暂停动画，这个不会将动画从Ticker中移除

Returns void
- Defined in animation/Animation.ts:277

play

play(startOrClipName?: string | number, end?: number): void
播放动画(剪辑)
Parameters
- OptionalstartOrClipName: string | number
  动画开始时间，或者动画剪辑名字
- Optionalend: number
  动画结束时间，如果是剪辑的话不需要传
Returns void
- Defined in animation/Animation.ts:235

removeClip

removeClip(name: string): void
移除动画剪辑
Parameters
- name: string
  需要移除的剪辑名字
Returns void
- Defined in animation/Animation.ts:147

resume

resume(): void
恢复动画播放，只能针对 pause 暂停后恢复

Returns void
- Defined in animation/Animation.ts:283

stop

stop(): void
停止动画，这个会将动画从Ticker中移除，需要重新调用play才能再次播放

Returns void
- Defined in animation/Animation.ts:266

tick

tick(dt: number): void
tick
Parameters
- dt: number
Returns void
- Defined in animation/Animation.ts:197

updateAnimStates

updateAnimStates(): this
更新动画状态

Returns this
this
- Defined in animation/Animation.ts:224

`Static`tick

tick(dt: number): void
tick
Parameters
- dt: number
  一帧时间
Returns void
- Defined in animation/Animation.ts:40

Class Animation

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Animation

Properties

_listeners

className

clipEndTime

clips

clipStartTime

currentLoopCount

currentTime

endTime

Readonlyid

isAnimation

loop

nodeNameMap

paused

startTime

timeScale

validAnimationIds

Static Readonly_anims

Accessors

animStatesList

Returns AnimationStates[]

Parameters

Returns void

rootNode

Returns Node | null

Parameters

Returns void

Methods

_initNodeNameMap

Returns void

addClip

Parameters

Returns void

clone

Parameters

Returns Animation

fire

Parameters

Returns boolean

getAnimStatesListTimeInfo

Parameters

Returns AnimationTimeRange

off

Parameters

Returns this

on

Parameters

Returns this

pause

Returns void

play

Parameters

Returns void

removeClip

Parameters

Returns void

resume

Returns void

stop

Returns void

tick

Parameters

Returns void

updateAnimStates

Returns this

Statictick

Parameters

Returns void

Settings

`Readonly`id

`Static` `Readonly`_anims

`Static`tick