SkeletalAnimationState | Creator3dAPI

Hierarchy

AnimationState
- SkeletalAnimationState

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

newSkeletalAnimationState(clip: AnimationClip, name?: string, preSample?: boolean): SkeletalAnimationState

Overrides AnimationState.constructor
- Defined in cocos/core/animation/skeletal-animation-state.ts:53
Parameters
- clip: AnimationClip
- Default value name: string = ""
- Default value preSample: boolean = true
Returns SkeletalAnimationState

Properties

Protected _animInfo

_animInfo: IAnimInfo | null = null

Protected _clip

_clip: AnimationClip

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 _frames

_frames: number = 1

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 _preSample

_preSample: boolean = true

Protected _process

_process: process = this.process

Protected _repeatCount

_repeatCount: number = 1

Protected _samplerSharedGroups

_samplerSharedGroups: ISamplerSharedGroup[] = []

Protected _sockets

_sockets: ISocketData[] = []

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

get clip(): AnimationClip

Inherited from AnimationState.clip
- Defined in cocos/core/animation/animation-state.ts:211
此动画状态正在播放的剪辑。

Returns AnimationClip

curveLoaded

get curveLoaded(): boolean

Inherited from AnimationState.curveLoaded
- Defined in cocos/core/animation/animation-state.ts:374
Returns boolean

delay

get delay(): number
set delay(value: number): void

Inherited from AnimationState.delay
- Defined in cocos/core/animation/animation-state.ts:294
延迟多少秒播放。

default

0

Returns number
Inherited from AnimationState.delay
- Defined in cocos/core/animation/animation-state.ts:298
Parameters
- value: number
Returns void

isPaused

get isPaused(): boolean

Inherited from Playable.isPaused
- Defined in cocos/core/animation/playable.ts:23
当前是否正在暂停。

default

false

Returns boolean

isPlaying

get isPlaying(): boolean

Inherited from Playable.isPlaying
- Defined in cocos/core/animation/playable.ts:14
当前是否正在播放。

default

false

Returns boolean

length

get length(): number

Inherited from AnimationState.length
- Defined in cocos/core/animation/animation-state.ts:223
Returns number

name

get name(): string

Inherited from AnimationState.name
- Defined in cocos/core/animation/animation-state.ts:219
动画的名字。

Returns string

repeatCount

get repeatCount(): number
set repeatCount(value: number): void

Inherited from AnimationState.repeatCount
- Defined in cocos/core/animation/animation-state.ts:271
迭代次数，指动画播放多少次后结束, normalize time。如 2.5（2次半）。

property

repeatCount

type

{Number}

default

1

Returns number
Inherited from AnimationState.repeatCount
- Defined in cocos/core/animation/animation-state.ts:275
Parameters
- value: number
Returns void

wrapMode

get wrapMode(): WrapMode
set wrapMode(value: WrapMode): void

Inherited from AnimationState.wrapMode
- Defined in cocos/core/animation/animation-state.ts:236
动画循环方式。需要注意的是，动态修改 wrapMode 时，会重置 time 以及 repeatCount。

default:

WrapMode.Normal

Returns WrapMode
Inherited from AnimationState.wrapMode
- Defined in cocos/core/animation/animation-state.ts:240
Parameters
- value: WrapMode
Returns void

Methods

Private buildSocketData

buildSocketData(socket: Socket): null | ISocketData

- Defined in cocos/core/animation/skeletal-animation-state.ts:103
Parameters
- socket: Socket
Returns null | ISocketData

emit

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

Inherited from AnimationState.emit
- Defined in cocos/core/animation/animation-state.ts:429
Parameters
- type: any
- state: any
Returns void

needReverse

needReverse(currentIterations: number): boolean

Inherited from AnimationState.needReverse
- Defined in cocos/core/animation/animation-state.ts:539
Parameters
- currentIterations: number
Returns boolean

Protected sampleCurves

sampleCurves(ratio: number): void

Overrides AnimationState.sampleCurves
- Defined in cocos/core/animation/skeletal-animation-state.ts:92
Parameters
- ratio: number
Returns void

setEventTarget

setEventTarget(target: any): void

Inherited from AnimationState.setEventTarget
- Defined in cocos/core/animation/animation-state.ts:487
Parameters
- target: any
Returns void

attachToBlendState

attachToBlendState(blendState: AnimationBlendState): void

Inherited from AnimationState.attachToBlendState
- Defined in cocos/core/animation/animation-state.ts:673
Parameters
- blendState: AnimationBlendState
Returns void

cache

cache(frames: number): void

Inherited from AnimationState.cache
- Defined in cocos/core/animation/animation-state.ts:689
Parameters
- frames: number
Returns void

detachFromBlendState

detachFromBlendState(blendState: AnimationBlendState): void

Inherited from AnimationState.detachFromBlendState
- Defined in cocos/core/animation/animation-state.ts:681
Parameters
- blendState: AnimationBlendState
Returns void

emit

emit<K>(type: K, ...args: EventArgumentsOf<K, IAnimationEventDefinitionMap>): void

Inherited from AnimationState.emit
- Defined in cocos/core/animation/animation-state.ts:435
Type parameters
- K: string
Parameters
- type: K
- Rest ...args: EventArgumentsOf<K, IAnimationEventDefinitionMap>
Returns void

getWrappedInfo

getWrappedInfo(time: number, info?: WrappedInfo): WrappedInfo

Inherited from AnimationState.getWrappedInfo
- Defined in cocos/core/animation/animation-state.ts:560
Parameters
- time: number
- Optional info: WrappedInfo
Returns WrappedInfo

initialize

initialize(root: Node): void

Overrides AnimationState.initialize
- Defined in cocos/core/animation/skeletal-animation-state.ts:60
Parameters
- root: Node
Returns void

off

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

Inherited from AnimationState.off
- Defined in cocos/core/animation/animation-state.ts:476
Parameters
- type: string
- callback: Function
- Optional target: any
Returns void

on

on<K>(type: K, callback: EventCallbackOf<K, IAnimationEventDefinitionMap>, target?: any): void

Inherited from AnimationState.on
- Defined in cocos/core/animation/animation-state.ts:445
Type parameters
- K: string
Parameters
- type: K
- callback: EventCallbackOf<K, IAnimationEventDefinitionMap>
- Optional target: any
Returns void

Protected onError

onError(message: string): void

Inherited from Playable.onError
- Defined in cocos/core/animation/playable.ts:116
Parameters
- message: string
Returns void

Protected onPause

onPause(): void

Inherited from AnimationState.onPause

Overrides Playable.onPause
- Defined in cocos/core/animation/animation-state.ts:715
Returns void

onPlay

onPlay(): void

Overrides AnimationState.onPlay
- Defined in cocos/core/animation/skeletal-animation-state.ts:73
Returns void

Protected onResume

onResume(): void

Inherited from AnimationState.onResume

Overrides Playable.onResume
- Defined in cocos/core/animation/animation-state.ts:710
Returns void

Protected onStop

onStop(): void

Inherited from AnimationState.onStop

Overrides Playable.onStop
- Defined in cocos/core/animation/animation-state.ts:702
Returns void

once

once<K>(type: K, callback: EventCallbackOf<K, IAnimationEventDefinitionMap>, target?: any): void

Inherited from AnimationState.once
- Defined in cocos/core/animation/animation-state.ts:459
Type parameters
- K: string
Parameters
- type: K
- callback: EventCallbackOf<K, IAnimationEventDefinitionMap>
- Optional target: any
Returns void

pause

pause(): void

Inherited from Playable.pause
- Defined in cocos/core/animation/playable.ts:66
暂停动画。

Returns void

play

play(): void

Inherited from Playable.play
- Defined in cocos/core/animation/playable.ts:34
播放动画。

Returns void

process

process(): void

Inherited from AnimationState.process
- Defined in cocos/core/animation/animation-state.ts:622
Returns void

rebuildSocketCurves

rebuildSocketCurves(sockets: Socket[]): void

- Defined in cocos/core/animation/skeletal-animation-state.ts:84
Parameters
- sockets: Socket[]
Returns void

resume

resume(): void

Inherited from Playable.resume
- Defined in cocos/core/animation/playable.ts:77
重新播放动画。

Returns void

sample

sample(): WrappedInfo

Inherited from AnimationState.sample
- Defined in cocos/core/animation/animation-state.ts:613
Returns WrappedInfo

setTime

setTime(time: number): void

Inherited from AnimationState.setTime
- Defined in cocos/core/animation/animation-state.ts:491
Parameters
- time: number
Returns void

simpleProcess

simpleProcess(): void

Inherited from AnimationState.simpleProcess
- Defined in cocos/core/animation/animation-state.ts:647
Returns void

step

step(): void

Inherited from Playable.step
- Defined in cocos/core/animation/playable.ts:88
执行一帧动画。

Returns void

stop

stop(): void

Inherited from Playable.stop
- Defined in cocos/core/animation/playable.ts:52
停止动画播放。

Returns void

update

update(delta: number): void

Inherited from AnimationState.update

Overrides Playable.update
- Defined in cocos/core/animation/animation-state.ts:515
Parameters
- delta: number
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

clip: AnimationClip

Default value name: string = ""

Default value preSample: boolean = true

Returns SkeletalAnimationState

Properties

Protected _animInfo

Protected _clip

Protected commonTargetStatuses

Protected _currentFramePlayed

Protected _curveLoaded

Protected _delay

Protected _delayTime

Protected _frames

Protected _ignoreIndex

Protected Optional _lastIterations

Protected _lastWrapInfo

Protected _lastWrapInfoEvent

_lastframeEventOn

Protected _name

Protected _preSample

Protected _process

Protected _repeatCount

Protected _samplerSharedGroups

Protected _sockets

Protected _target

Protected _targetNode

Protected _wrapMode

Protected _wrappedInfo

duration

frameRate

speed

time

weight

Accessors

clip

Returns AnimationClip

curveLoaded

Returns boolean

delay

Returns number

Parameters

value: number

Returns void

isPaused

Returns boolean

isPlaying

Returns boolean

length

Returns number

name

Returns string

repeatCount

Returns number

Parameters

value: number

Returns void

wrapMode

Returns WrapMode

Parameters

value: WrapMode

Returns void

Methods

Private buildSocketData

Parameters

socket: Socket

Returns null | ISocketData

emit

Parameters

type: any

state: any

Returns void