Class Animation

动画组件

Export

Date

2022.3.31

Author

lyx

Hierarchy

Component
- Animation

Constructors

constructor

new Animation(entity, parameters): Animation
Parameters
- entity: Entity
- parameters: AnimationParameters
Returns Animation

Overrides Component.constructor

Properties

`Protected` _engine

_engine: Engine

`Protected` _entity

_entity: Entity

`Readonly` onAnimationFinished

onAnimationFinished: AnimationListener = ...

动画结束回调（适用于LoopOnce模式）

Memberof

Animation

`Readonly` onAnimationLoop

onAnimationLoop: AnimationListener = ...

动画循环回调（每完成一次循环触发一次回调，适用于LoopRepeat和LoopPingPong模式）

Memberof

Animation

userData

userData: {
[key: string]: any;
} = {}

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Component.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.enabled

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Component.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Component.entity

Methods

`Protected` _onAwake

_onAwake(): void
Protected
唤醒组件

Returns void

Memberof
Component

Inherited from Component._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁组件

Returns void

Memberof
Animation

Overrides Component._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用动画组件

Returns void

Memberof
Animation

Overrides Component._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用动画组件

Returns void

Memberof
Animation

Overrides Component._onEnable

addAnimation

addAnimation(animation): void
添加一个动画
Parameters
- animation: AnimationClipParameters
Returns void

Memberof
Animation

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Component.addEventListener

animationNames

animationNames(): string[]
获取动画名称

Returns string[]

Memberof
Animation

crossFadeFromTo

crossFadeFromTo(fadeOutName, fadeInName, duration, wrap): void
从某一动画渐变到另一动画
Parameters
- fadeOutName: string
  
  渐出动画名称
- fadeInName: string
  
  渐入动画名称
- duration: number
  
  渐变时长（单位：秒）
- wrap: boolean
Returns void

Memberof
Animation

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Component.destroy

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Component.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Component.dispose

fadeIn

fadeIn(name, duration): void
动画渐入
Parameters
- name: string
  
  动画名称
- duration: number
  
  渐入时长（单位：秒）
Returns void

Memberof
Animation

fadeOut

fadeOut(name, duration): void
动画渐出
Parameters
- name: string
  
  动画名称
- duration: number
  
  渐出时长（单位：秒）
Returns void

Memberof
Animation

getDuration

getDuration(name): number
获取动画播放总时长（单位：秒）
Parameters
- name: string
  
  动画名称
Returns number

Memberof
Animation

getEffectiveTimeScale

getEffectiveTimeScale(name): number
获取动画的有效时间缩放
Parameters
- name: string
  
  动画名称
Returns number

Memberof
Animation

getEffectiveWeight

getEffectiveWeight(name): number
获取动画有效权重
Parameters
- name: string
  
  动画名称
Returns number

Memberof
Animation

getTime

getTime(name): number
获取当前动画时刻
Parameters
- name: string
Returns number

Memberof
Animation

getTimeScale

getTimeScale(name): number
获取动画的时间缩放
Parameters
- name: string
  
  动画名称
Returns number

Memberof
Animation

getWeight

getWeight(name): number
获取动画权重
Parameters
- name: string
  
  动画名称
Returns number

Memberof
Animation

isPaused

isPaused(name): boolean
判断动画是否被暂停
Parameters
- name: string
  
  动画名称
Returns boolean

Memberof
Animation

isRunning

isRunning(name): boolean
判断动画是否正在运行
Parameters
- name: string
  
  动画名称
Returns boolean

Memberof
Animation

isScheduled

isScheduled(name): boolean
判断动画是否已调用播放
Parameters
- name: string
  
  动画名称
Returns boolean

Memberof
Animation

pause

pause(name, paused): void
暂停动画
Parameters
- name: string
  
  动画名称
- paused: boolean
  
  是否暂停
Returns void

Memberof
Animation

play

play(name): void
播放动画
Parameters
- name: string
  
  动画名称
Returns void

Memberof
Animation

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Component.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Component.removeEventListenerByEventId

reset

reset(name): void
重置动画
Parameters
- name: string
  
  动画名称
Returns void

Memberof
Animation

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Component.setActive

setClampWhenFinished

setClampWhenFinished(name, clampWhenFinished): void
设置动画播放结束后停在最后一帧还是回到初始帧
Parameters
- name: string
  
  动画名称
- clampWhenFinished: boolean
  
  是否自动停止
Returns void

Memberof
Animation

setDuration

setDuration(name, duration): void
设置动画每次播放总时长
Parameters
- name: string
  
  动画名称
- duration: number
  
  动画总时长（单位：秒）
Returns void

Memberof
Animation

setEffectiveTimeScale

setEffectiveTimeScale(name, timeScale): void
设置动画的有效时间缩放
Parameters
- name: string
  
  动画名称
- timeScale: number
  
  时间缩放量
Returns void

Memberof
Animation

setEffectiveWeight

setEffectiveWeight(name, weight): void
设置动画有效权重
Parameters
- name: string
  
  动画名称
- weight: number
  
  动画权重在[ 0 ~ 1 ]区间
Returns void

Memberof
Animation

setEnabled

setEnabled(name, enable): void
设置动画是否启用
Parameters
- name: string
  
  动画名称
- enable: boolean
  
  true启用，false禁用
Returns void

Memberof
Animation

setLoop

setLoop(name, mode, repetitions): void
设置动画播放循环状态
Parameters
- name: string
  
  动画名称
- mode: AnimationActionLoopStyles
  
  循环状态（LoopOnce、LoopRepeat、LoopPingPong）
- repetitions: number
  
  重复次数
Returns void

Memberof
Animation

setStartAt

setStartAt(name, time): void
设置动画开始时刻
Parameters
- name: string
  
  动画名称
- time: number
  
  时刻
Returns void

Memberof
Animation

setStopAt

setStopAt(name, time): void
设置动画结束时刻
Parameters
- name: string
  
  动画名称
- time: number
  
  时刻
Returns void

Memberof
Animation

setTime

setTime(name, time): void
设置当前动画时刻
Parameters
- name: string
  
  动画名称
- time: number
  
  开始时刻（单位：秒）
Returns void

Memberof
Animation

setTimeScale

setTimeScale(name, timeScale): void
设置动画的时间缩放（用于控制动画播放速度）
Parameters
- name: string
  
  动画名称
- timeScale: number
  
  时间缩放量
Returns void

Memberof
Animation

setWeight

setWeight(name, weight): void
设置动画权重
Parameters
- name: string
  
  动画名称
- weight: number
  
  动画权重在[ 0 ~ 1 ]区间
Returns void

Memberof
Animation

stop

stop(name): void
停止动画播放
Parameters
- name: string
  
  动画名称
Returns void

Memberof
Animation

stopFading

stopFading(name): void
停止动画渐变操作
Parameters
- name: string
  
  动画名称
Returns void

Memberof
Animation

update

update(timeSinceLastFrame, totalTime): void
更新动画
Parameters
- timeSinceLastFrame: number
  
  距离上一帧更新的时长（单位：毫秒）
- totalTime: number
  
  总时长 (单位：毫秒)
Returns void

Memberof
Animation

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Component.updateProperties