Class Animator

生成动画

Constructors

constructor

new Animator(options): Animator
Parameters
- options: AnimatorOptions
Returns Animator

Properties

animateMixer

animateMixer: AnimationMixer

animationClips

animationClips: AnimationClip[] = []

isAnimator

isAnimator: boolean = true

signal

signal: {
onFinished: Signal;
onLoop: Signal;
} = ...

Type declaration

onFinished: Signal
onLoop: Signal

uiConfig

uiConfig: UiObjectConfig<any, string, any>

Methods

addAnimationClip

addAnimationClip(clip): AnimationClip
增加关键帧动画
Parameters
- clip: AnimationClip | AnimatorOptions
Returns AnimationClip

addAnimationSubclip

addAnimationSubclip(sourceClip, startFrame, endFrame?, subclipName?, fps?): void
增加子裁剪关键帧动画
Parameters
- sourceClip: string | number | AnimationClip
  源关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- startFrame: number
  开始帧位置
- Optional endFrame: number
  结束帖位置
- Optional subclipName: string
  子帧名称
- Optional fps: number
  帖率
Returns void

addMaterialColorAnimation

addMaterialColorAnimation(duration?, colors?, name?): AnimationClip
增加颜色变化动作
Parameters
- Optional duration: number
- Optional colors: {
      b: number;
      g: number;
      r: number;
  }[]
  颜色列表
- name: any = null
  动作名称
Returns AnimationClip

addPulsationAnimation

addPulsationAnimation(duration?, pulseScale?, name?): AnimationClip
增加脉动动作
Parameters
- Optional duration: number
- Optional pulseScale: number
  脉动比例默认1.2
- name: any = null
  动作名称
Returns AnimationClip

addRotationAnimation

addRotationAnimation(period?, axis?, name?): AnimationClip
增加旋转动作
Parameters
- Optional period: number
  周期时间默认3s = 60 * 3
- axis: string = 'y'
  方向轴默认绕y轴 "y"
- name: any = null
  动作名称
Returns AnimationClip

addScaleAxisAnimation

addScaleAxisAnimation(period?, axis?, name?): AnimationClip
增加缩放动作
Parameters
- Optional period: number
  周期时间默认3s = 60 * 3
- axis: string = 'y'
  方向轴默认绕y轴 "y"
- name: any = null
  动作名称
Returns AnimationClip

addShakeAnimation

addShakeAnimation(duration?, shakeScale?, name?): AnimationClip
增加晃动动作
Parameters
- Optional duration: number
- Optional shakeScale: number | Vector3
  晃动比例默认 1.2
- name: any = null
  动作名称
Returns AnimationClip

addTo

addTo(app, autoPlay?): void
主动添加加至应用中
Parameters
- app: App
- Optional autoPlay: boolean
  是否自动播放动画，默认是
Returns void

addVisibilityAnimation

addVisibilityAnimation(duration?, name?): AnimationClip
增加闪烁动作
Parameters
- Optional duration: number
- name: any = null
  动作名称
Returns AnimationClip

crossFadeFrom

crossFadeFrom(name, fadeOutAction, duration, warp): AnimationAction
在传入的时间段内，让此动作淡入(fade in),同时让另一个动作淡出。
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- fadeOutAction: AnimationAction
  淡出的另一个动作
- duration: number
  持续时间
- warp: boolean
  如值是true, 额外的 warping (时间比例的渐变)将会被应用。
Returns AnimationAction

crossFadeTo

crossFadeTo(name, fadeInAction, duration, warp): AnimationAction
在传入的时间段内, 让此动作淡出（fade out），同时让另一个动作淡入
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- fadeInAction: AnimationAction
  淡出的动作
- duration: number
  持续时间
- warp: boolean
  如值是true, 额外的 warping (时间比例的渐变)将会被应用。
Returns AnimationAction

dispose

dispose(): void
Returns void

fadeIn

fadeIn(name, duration): AnimationAction
在传入的时间间隔内，逐渐将此动作的权重（weight）由0升到1
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- duration: number
  持续时间
Returns AnimationAction

fadeOut

fadeOut(name, duration): AnimationAction
在传入的时间间隔内，逐渐将此动作的权重（weight）由1降至0。
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- duration: number
  持续时间
Returns AnimationAction

getAnimateMixer

getAnimateMixer(): AnimationMixer
获取动画混合器

Returns AnimationMixer

getAnimationClips

getAnimationClips(): AnimationClip[]
获取关键帧动画数组

Returns AnimationClip[]

getClip

getClip(name): AnimationClip
获取关键帧动画
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns AnimationClip

getClipNames

getClipNames(): string[]
获取所有关键动画帧名称

Returns string[]

getEffectiveTimeScale

getEffectiveTimeScale(name): number
获取时间比例
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns number

getEffectiveWeight

getEffectiveWeight(name): number
获取权重
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns number

getclipAction

getclipAction(name): AnimationAction
获取关键帧动画动作
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns AnimationAction

halt

halt(name, duration): AnimationAction
在传入的时间间隔内，通过从当前值开始逐渐降低时间比例(timeScale)使动画逐渐减速至0
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- duration: number
  持续时间
Returns AnimationAction

isRunning

isRunning(name): boolean
关键帧动画是否在运行
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns boolean

isScheduled

isScheduled(name): boolean
如果动作是在混合器中被激活的，返回true。这并不意味着动画正在执行中 (需要额外判断isRunning值)
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns boolean

play

play(name?): AnimationAction
播放关键帧动画
Parameters
- Optional name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象如果不输入，则指第1个动画
Returns AnimationAction

remove

remove(): void
从应用中移除此动画

Returns void

reset

reset(name): AnimationAction
重置关键帧动画
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns AnimationAction

setClampWhenFinished

setClampWhenFinished(name, clampWhenFinished): void
设置动画播放结束后是停在最后还是回到开始位置
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- clampWhenFinished: boolean
  如果 clampWhenFinished 值设为true, 那么动画将在最后一帧之后自动暂停如果 clampWhenFinished 值为false, enabled 属性值将在动作的最后一次循环完成之后自动改为false, 那么这个动作以后就不会再执行
Returns void
Memberof
Animation

setDuration

setDuration(name, duration): AnimationAction
设置单次循环的持续时间(通过调整时间比例（timeScale）以及停用所有的变形)
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- duration: number
Returns AnimationAction

setEffectiveTimeScale

setEffectiveTimeScale(name, timeScale): AnimationAction
设置时间比例（timeScale）以及停用所有的变形)
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- timeScale: number
  时间比例
Returns AnimationAction

setEffectiveWeight

setEffectiveWeight(name, weight): AnimationAction
设置权重以及停止所有淡入淡出
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- weight: number
  权重值
Returns AnimationAction

setEnable

setEnable(name, enabled): void
设置动画是否能用
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- enabled: boolean
  是否启用
Returns void
Memberof
Animation

setLoop

setLoop(name, mode, repetitions): AnimationAction
设置动画循环参数
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- mode: AnimationActionLoopStyles
  循环状态
- repetitions: number
  循环次数
Returns AnimationAction
mode 循环状态

setTime

setTime(timeInSeconds): AnimationMixer
设置时间
Parameters
- timeInSeconds: number
Returns AnimationMixer

startAt

startAt(name, time): AnimationAction
动画开始时间
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- time: number
  开始时间
Returns AnimationAction

stop

stop(name?): AnimationAction
停止关键帧动画
Parameters
- Optional name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象如果不输入，则指所有的动画名称
Returns AnimationAction

stopAllAction

stopAllAction(): AnimationMixer
停止所有动作

Returns AnimationMixer

stopFading

stopFading(name): AnimationAction
停止动作中所有预定的淡入淡出（fading）
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns AnimationAction

stopWarping

stopWarping(name): AnimationAction
停用动作中所有预定的变形warping
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
Returns AnimationAction

syncWith

syncWith(name, action): AnimationAction
将此动作与传入的其它动作同步
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- action: AnimationAction
  需同步的动作
Returns AnimationAction

update

update(delta): void
Parameters
- delta: number
Returns void

warp

warp(name, statTimeScale, endTimeScale, duration): AnimationAction
在传入的事件间隔内，通过逐渐将时间比例timeScale由startTimeScale修改至endTimeScale来改变回放速度。
Parameters
- name: string | number | AnimationClip
  关键帧动画名称或关键帧动画数组索引或关键帧动画对象
- statTimeScale: number
  开始时间比例
- endTimeScale: number
  终止时间比例
- duration: number
  持续时长
Returns AnimationAction