Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnimationState

AnimationState 完全控制动画播放过程。
大多数情况下 动画组件 是足够和易于使用的。如果您需要更多的动画控制接口,请使用 AnimationState。

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns AnimationState

Properties

Protected _clip

Protected commonTargetStatuses

commonTargetStatuses: Array<object> = []

Protected _currentFramePlayed

_currentFramePlayed: boolean = false

Mark whether the current frame is played. When set new time to animation state, we should ensure the frame at the specified time being played at next update.

Protected _curveLoaded

_curveLoaded: boolean = false

Protected _delay

_delay: number = 0

Protected _delayTime

_delayTime: number = 0

Protected _ignoreIndex

_ignoreIndex: number = InvalidIndex

Protected Optional _lastIterations

_lastIterations: undefined | number

Protected _lastWrapInfo

_lastWrapInfo: WrappedInfo | null = null

Protected _lastWrapInfoEvent

_lastWrapInfoEvent: WrappedInfo | null = null

_lastframeEventOn

_lastframeEventOn: boolean = false

Protected _name

_name: string

Protected _process

_process: process = this.process

Protected _repeatCount

_repeatCount: number = 1

Protected _samplerSharedGroups

_samplerSharedGroups: ISamplerSharedGroup[] = []

Protected _target

_target: Node | null = null

Protected _targetNode

_targetNode: Node | null = null

Protected _wrapMode

_wrapMode: WrapMode = WrapMode.Normal

Protected _wrappedInfo

_wrappedInfo: WrappedInfo = new WrappedInfo()

duration

duration: number = 1

单次动画的持续时间,秒。(动画长度)

readonly

frameRate

frameRate: number = 0

speed

speed: number = 1

播放速率。

default:

1.0

time

time: number = 0

动画当前的时间,秒。

default

0

weight

weight: number = 0

The weight.

Accessors

clip

  • 此动画状态正在播放的剪辑。

    Returns AnimationClip

curveLoaded

  • get curveLoaded(): boolean
  • Returns boolean

delay

  • get delay(): number
  • set delay(value: number): void
  • 延迟多少秒播放。

    default

    0

    Returns number

  • Parameters

    • value: number

    Returns void

isPaused

  • get isPaused(): boolean
  • 当前是否正在暂停。

    default

    false

    Returns boolean

isPlaying

  • get isPlaying(): boolean
  • 当前是否正在播放。

    default

    false

    Returns boolean

length

  • get length(): number
  • Returns number

name

  • get name(): string
  • 动画的名字。

    Returns string

repeatCount

  • get repeatCount(): number
  • set repeatCount(value: number): void
  • 迭代次数,指动画播放多少次后结束, normalize time。 如 2.5(2次半)。

    property

    repeatCount

    type

    {Number}

    default

    1

    Returns number

  • Parameters

    • value: number

    Returns void

wrapMode

  • 动画循环方式。 需要注意的是,动态修改 wrapMode 时,会重置 time 以及 repeatCount。

    default:

    WrapMode.Normal

    Returns WrapMode

  • Parameters

    Returns void

Methods

emit

  • emit(type: any, state: any): void
  • Parameters

    • type: any
    • state: any

    Returns void

Private fireEvent

  • fireEvent(index: number): void
  • Parameters

    • index: number

    Returns void

needReverse

  • needReverse(currentIterations: number): boolean
  • Parameters

    • currentIterations: number

    Returns boolean

Protected sampleCurves

  • sampleCurves(ratio: number): void
  • Parameters

    • ratio: number

    Returns void

Private sampleEvents

  • Parameters

    Returns void

setEventTarget

  • setEventTarget(target: any): void
  • Parameters

    • target: any

    Returns void

attachToBlendState

  • Parameters

    Returns void

cache

  • cache(frames: number): void
  • Parameters

    • frames: number

    Returns void

detachFromBlendState

  • Parameters

    Returns void

emit

  • Type parameters

    • K: string

    Parameters

    Returns void

getWrappedInfo

  • Parameters

    Returns WrappedInfo

initialize

  • initialize(root: Node, propertyCurves?: readonly, IRuntimeCurve: any, __namedParameters: []): void
  • Parameters

    • root: Node
    • Optional propertyCurves: readonly
    • IRuntimeCurve: any
    • __namedParameters: []

    Returns void

off

  • off(type: string, callback: Function, target?: any): void
  • Parameters

    • type: string
    • callback: Function
    • Optional target: any

    Returns void

on

  • Type parameters

    • K: string

    Parameters

    Returns void

Protected onError

  • onError(message: string): void
  • Parameters

    • message: string

    Returns void

Protected onPause

  • onPause(): void
  • Returns void

Protected onPlay

  • onPlay(): void
  • Returns void

Protected onResume

  • onResume(): void
  • Returns void

Protected onStop

  • onStop(): void
  • Returns void

once

  • Type parameters

    • K: string

    Parameters

    Returns void

pause

  • pause(): void
  • 暂停动画。

    Returns void

play

  • play(): void
  • 播放动画。

    Returns void

process

  • process(): void
  • Returns void

resume

  • resume(): void
  • 重新播放动画。

    Returns void

sample

  • Returns WrappedInfo

setTime

  • setTime(time: number): void
  • Parameters

    • time: number

    Returns void

simpleProcess

  • simpleProcess(): void
  • Returns void

step

  • step(): void
  • 执行一帧动画。

    Returns void

stop

  • stop(): void
  • 停止动画播放。

    Returns void

update

  • update(delta: number): void
  • Parameters

    • delta: number

    Returns void

Generated using TypeDoc