Class DefaultAnimatorController

Default Animator controller

Export

DefaultAnimatiorController

Hierarchy (view full)

AnimatorController
- DefaultAnimatorController

Constructors

constructor

new DefaultAnimatorController(root, animations): DefaultAnimatorController
Parameters
- root: Object3D<Object3DEventMap>
- animations: AnimationClip[]
Returns DefaultAnimatorController
Overrides AnimatorController.constructor

Accessors

animationClips

get animationClips(): readonly AnimationClip[]
Three.js AnimationClip array

Returns readonly AnimationClip[]
Memberof
DefaultAnimatorController

animationMixer

get animationMixer(): AnimationMixer
Three.js AnimationMixer

Returns AnimationMixer
Memberof
DefaultAnimatorController

Methods

animationNames

animationNames(): string[]
Animation names

Returns string[]
Memberof
Animator

crossFadeFromTo

crossFadeFromTo(fadeOutName, fadeInName, duration, wrap): void
Crosss Fade
Parameters
- fadeOutName: string
- fadeInName: string
- duration: number
- wrap: boolean
Returns void
Memberof
Animator

destroy

destroy(): void
Destroy

Returns void
Memberof
DefaultAnimatorController

Overrides AnimatorController.destroy

fadeIn

fadeIn(name, duration): void
Fade in
Parameters
- name: string
- duration: number
Returns void
Memberof
Animator

fadeOut

fadeOut(name, duration): void
Fade out
Parameters
- name: string
- duration: number
Returns void
Memberof
Animator

getDuration

getDuration(name): number
Get duration
Parameters
- name: string
Returns number
Memberof
Animator

getEffectiveTimeScale

getEffectiveTimeScale(name): number
Get effective time scale
Parameters
- name: string
Returns number
Memberof
Animator

getEffectiveWeight

getEffectiveWeight(name): number
Get effective weight
Parameters
- name: string
Returns number
Memberof
Animator

getTime

getTime(name): number
Get time
Parameters
- name: string
Returns number
Memberof
Animator

getTimeScale

getTimeScale(name): number
Get time scale
Parameters
- name: string
Returns number
Memberof
Animator

getWeight

getWeight(name): number
Get weight
Parameters
- name: string
Returns number
Memberof
Animator

halt

halt(name, durationInSeconds): void
Decelerates this animation's speed to 0 by decreasing timeScale gradually (starting from its current value), within the passed time interval.
Parameters
- name: string
- durationInSeconds: number
Returns void
Memberof
DefaultAnimatorController

isPaused

isPaused(name): boolean
Check is paused
Parameters
- name: string
Returns boolean
Memberof
Animator

isRunning

isRunning(name): boolean
Check is running
Parameters
- name: string
Returns boolean
Memberof
Animator

isScheduled

isScheduled(name): boolean
Check is scheduled
Parameters
- name: string
Returns boolean
Memberof
Animator

pause

pause(name, paused): void
Pause
Parameters
- name: string
- paused: boolean
Returns void
Memberof
Animator

Overrides AnimatorController.pause

play

play(name): void
Play
Parameters
- name: string
Returns void
Memberof
Animator

Overrides AnimatorController.play

reset

reset(name): void
reset
Parameters
- name: string
Returns void
Memberof
Animator

Overrides AnimatorController.reset

setClampWhenFinished

setClampWhenFinished(name, clampWhenFinished): void
Set clamp when finished
Parameters
- name: string
- clampWhenFinished: boolean
Returns void
Memberof
Animator

setDuration

setDuration(name, duration): void
Set duration
Parameters
- name: string
- duration: number
Returns void
Memberof
Animator

setEffectiveTimeScale

setEffectiveTimeScale(name, timeScale): void
Set effective time scale
Parameters
- name: string
- timeScale: number
Returns void
Memberof
Animator

setEffectiveWeight

setEffectiveWeight(name, weight): void
Set effective weight
Parameters
- name: string
- weight: number
Returns void
Memberof
Animator

setEnabled

setEnabled(name, enable): void
Set enable
Parameters
- name: string
- enable: boolean
Returns void
Memberof
Animator

setLoop

setLoop(name, mode, repetitions): void
Set Loop
Parameters
- name: string
- mode: AnimationActionLoopStyles
- repetitions: number
Returns void
Memberof
Animator

setStartAt

setStartAt(name, time): void
Set start at
Parameters
- name: string
- time: number
Returns void
Memberof
Animator

setStopAt

setStopAt(name, time): void
Set stop at
Parameters
- name: string
- time: number
Returns void
Memberof
DefaultAnimatorController

setTime

setTime(name, time): void
Set time
Parameters
- name: string
- time: number
Returns void
Memberof
Animator

setTimeScale

setTimeScale(name, timeScale): void
Set time scale
Parameters
- name: string
- timeScale: number
Returns void
Memberof
Animator

setWeight

setWeight(name, weight): void
Set weight
Parameters
- name: string
- weight: number
Returns void
Memberof
Animator

stop

stop(name): void
Stop
Parameters
- name: string
Returns void
Memberof
Animator

Overrides AnimatorController.stop

stopFading

stopFading(name): void
Stops any scheduled fading which is applied to this action.
Parameters
- name: string
Returns void
Memberof
Animator

stopWraping

stopWraping(name): void
Stops any scheduled warping which is applied to this action.
Parameters
- name: string
Returns void
Memberof
DefaultAnimatorController

syncWith

syncWith(name, otherName): void
Synchronizes two animations
Parameters
- name: string
- otherName: string
Returns void
Memberof
DefaultAnimatorController

update

update(deltaTime): void
Update
Parameters
- deltaTime: number
Returns void
Memberof
Animator

Overrides AnimatorController.update

wrap

wrap(name, startTimeScale, endTimeScale, duration): void
Changes the playback speed, within the passed time interval, by modifying timeScale gradually from startTimeScale to endTimeScale.
Parameters
- name: string
- startTimeScale: number
- endTimeScale: number
- duration: number
Returns void
Memberof
DefaultAnimatorController