Class MotionManager<Motion, MotionSpec>`Abstract`

Handles the motion playback.

Emits

MotionManagerEvents

Type Parameters

Motion = any
MotionSpec = any

Hierarchy

EventEmitter
- MotionManager
  - Cubism2MotionManager
  - Cubism4MotionManager

Constructors

`Protected` constructor

new MotionManager<Motion, MotionSpec>(settings: ModelSettings, options?: MotionManagerOptions): MotionManager<Motion, MotionSpec>
Type Parameters
- Motion = any
- MotionSpec = any
Parameters
- settings: ModelSettings
- Optional options: MotionManagerOptions
Returns MotionManager<Motion, MotionSpec>
Overrides EventEmitter.constructor
- Defined in src/cubism-common/MotionManager.ts:104

Properties

`Optional` currentAudio

currentAudio?: HTMLAudioElement

Audio element of the current motion if a sound file is defined with it.

`Readonly` `Abstract` definitions

definitions: Partial<Record<string, MotionSpec[]>>

Motion definitions copied from ModelSettings.

destroyed

destroyed: boolean = false

Flags the instances has been destroyed.

`Optional` `Abstract` expressionManager

expressionManager?: ExpressionManager<any, any>

Can be undefined if the settings defines no expression.

`Readonly` `Abstract` groups

groups: { idle: string }

Motion groups with particular internal usages. Currently there's only the idle field, which specifies the actual name of the idle motion group, so the idle motions can be correctly found from the settings JSON of various Cubism versions.

Type declaration

idle: string

`Readonly` `Abstract` motionDataType

motionDataType: "arraybuffer" | "json"

Indicates the content type of the motion files, varies in different Cubism versions. This will be used as xhr.responseType.

motionGroups

motionGroups: Partial<Record<string, (undefined | null | Motion)[]>> = {}

The Motions. The structure is the same as definitions, initially each group contains an empty array, which means all motions will be undefined. When a Motion has been loaded, it'll fill the place in which it should be; when it fails to load, the place will be filled with null.

playing

playing: boolean = false

Flags there's a motion playing.

`Readonly` settings

settings: ModelSettings

The ModelSettings reference.

state

state: MotionState = ...

Maintains the state of this MotionManager.

tag

tag: string

Tag for logging.

`Static` prefixed

prefixed: string | boolean

Methods

`Protected` `Abstract` _startMotion

_startMotion(motion: Motion, onFinish?: ((motion: Motion) => void)): number
Starts the Motion.
Parameters
- motion: Motion
- Optional onFinish: ((motion: Motion) => void)
  - - (motion: Motion): void
    - Parameters
      
      motion: Motion
      
      Returns void
Returns number
- Defined in src/cubism-common/MotionManager.ts:403

`Protected` `Abstract` _stopAllMotions

_stopAllMotions(): void
Stops all playing motions.

Returns void
- Defined in src/cubism-common/MotionManager.ts:408

addListener

addListener(event: string | symbol, fn: ListenerFn, context?: any): MotionManager<Motion, MotionSpec>
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns MotionManager<Motion, MotionSpec>
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

`Abstract` createMotion

createMotion(data: object | ArrayBuffer, group: string, definition: MotionSpec): Motion
Creates a Motion from the data.

Returns
The created Motion.
Parameters
- data: object | ArrayBuffer
  
  Content of the motion file. The format must be consistent with motionDataType.
- group: string
  
  The motion group.
- definition: MotionSpec
  
  The motion definition.
Returns Motion
- Defined in src/cubism-common/MotionManager.ts:380

destroy

destroy(): void
Destroys the instance.

Emits
destroy

Returns void
- Defined in src/cubism-common/MotionManager.ts:356

emit

emit(event: string | symbol, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:27

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

`Abstract` getMotionFile

getMotionFile(definition: MotionSpec): string
Retrieves the motion's file path by its definition.

Returns
The file path extracted from given definition. Not resolved.
Parameters
- definition: MotionSpec
Returns string
- Defined in src/cubism-common/MotionManager.ts:386

`Protected` `Abstract` getMotionName

getMotionName(definition: MotionSpec): string
Retrieves the motion's name by its definition.

Returns
The motion's name.
Parameters
- definition: MotionSpec
Returns string
- Defined in src/cubism-common/MotionManager.ts:392

`Protected` `Abstract` getSoundFile

getSoundFile(definition: MotionSpec): undefined | string
Retrieves the motion's sound file by its definition.

Returns
The motion's sound file, can be undefined.
Parameters
- definition: MotionSpec
Returns undefined | string
- Defined in src/cubism-common/MotionManager.ts:398

`Protected` init

init(options?: MotionManagerOptions): void
Should be called in the constructor of derived class.
Parameters
- Optional options: MotionManagerOptions
Returns void
- Defined in src/cubism-common/MotionManager.ts:114

`Abstract` isFinished

isFinished(): boolean
Checks if the motion playback has finished.

Returns boolean
- Defined in src/cubism-common/MotionManager.ts:371

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:22

listeners

listeners(event: string | symbol): ListenerFn[]
Return the listeners registered for a given event.
Parameters
- event: string | symbol
Returns ListenerFn[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

loadMotion

loadMotion(group: string, index: number): Promise<undefined | Motion>
Loads a Motion in a motion group. Errors in this method will not be thrown, but be emitted with a "motionLoadError" event.

Returns
Promise that resolves with the Motion, or with undefined if it can't be loaded.

Emits
motionLoaded

Emits
motionLoadError
Parameters
- group: string
  
  The motion group.
- index: number
  
  Index in the motion group.
Returns Promise<undefined | Motion>
- Defined in src/cubism-common/MotionManager.ts:168

off

off(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): MotionManager<Motion, MotionSpec>
Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns MotionManager<Motion, MotionSpec>
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

on(event: string | symbol, fn: ListenerFn, context?: any): MotionManager<Motion, MotionSpec>
Add a listener for a given event.
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns MotionManager<Motion, MotionSpec>
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:32

once

once(event: string | symbol, fn: ListenerFn, context?: any): MotionManager<Motion, MotionSpec>
Add a one-time listener for a given event.
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns MotionManager<Motion, MotionSpec>
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:38

removeAllListeners

removeAllListeners(event?: string | symbol): MotionManager<Motion, MotionSpec>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns MotionManager<Motion, MotionSpec>
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49

removeListener

removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): MotionManager<Motion, MotionSpec>
Remove the listeners of a given event.
Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns MotionManager<Motion, MotionSpec>
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43

`Protected` setupMotions

setupMotions(options?: MotionManagerOptions): void
Sets up motions from the definitions, and preloads them according to the preload strategy.
Parameters
- Optional options: MotionManagerOptions
Returns void
- Defined in src/cubism-common/MotionManager.ts:126

startMotion

startMotion(group: string, index: number, priority?: MotionPriority): Promise<boolean>
Starts a motion as given priority.

Returns
Promise that resolves with true if the motion is successfully started, with false otherwise.
Parameters
- group: string
  
  The motion group.
- index: number
  
  Index in the motion group.
- priority: MotionPriority = MotionPriority.NORMAL
  
  The priority to be applied.
Returns Promise<boolean>
- Defined in src/cubism-common/MotionManager.ts:209

startRandomMotion

startRandomMotion(group: string, priority?: MotionPriority): Promise<boolean>
Starts a random Motion as given priority.

Returns
Promise that resolves with true if the motion is successfully started, with false otherwise.
Parameters
- group: string
  
  The motion group.
- Optional priority: MotionPriority
  
  The priority to be applied.
Returns Promise<boolean>
- Defined in src/cubism-common/MotionManager.ts:288

stopAllMotions

stopAllMotions(): void
Stops all playing motions as well as the sound.

Returns void
- Defined in src/cubism-common/MotionManager.ts:313

update

update(model: object, now: number): boolean
Updates parameters of the core model.

Returns
True if the parameters have been actually updated.
Parameters
- model: object
  
  The core model.
- now: number
  
  Current time in milliseconds.
Returns boolean
- Defined in src/cubism-common/MotionManager.ts:330

`Protected` `Abstract` updateParameters

updateParameters(model: object, now: number): boolean
Updates parameters of the core model.

Returns
True if the parameters have been actually updated.
Parameters
- model: object
  
  The core model.
- now: number
  
  Current time in milliseconds.
Returns boolean
- Defined in src/cubism-common/MotionManager.ts:416

Class MotionManager<Motion, MotionSpec>Abstract

Emits

Type Parameters

Motion = any

MotionSpec = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

Motion = any

MotionSpec = any

Parameters

settings: ModelSettings

Optional options: MotionManagerOptions

Returns MotionManager<Motion, MotionSpec>

Properties

Optional currentAudio

Readonly Abstract definitions

destroyed

Optional Abstract expressionManager

Readonly Abstract groups

Type declaration

idle: string

Readonly Abstract motionDataType

motionGroups

playing

Readonly settings

state

tag

Static prefixed

Methods

Protected Abstract _startMotion

Parameters

motion: Motion

Optional onFinish: ((motion: Motion) => void)

Parameters

motion: Motion

Returns void

Returns number

Protected Abstract _stopAllMotions

Returns void

addListener

Parameters

event: string | symbol

fn: ListenerFn

Optional context: any

Returns MotionManager<Motion, MotionSpec>

Abstract createMotion

Returns

Parameters

data: object | ArrayBuffer

group: string

definition: MotionSpec

Returns Motion

destroy

Emits

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

Abstract getMotionFile

Returns

Parameters

definition: MotionSpec

Returns string

Protected Abstract getMotionName

Returns

Parameters

definition: MotionSpec

Returns string

Protected Abstract getSoundFile

Returns

Class MotionManager<Motion, MotionSpec>`Abstract`

`Protected` constructor

`Optional` options: MotionManagerOptions

`Optional` currentAudio

`Readonly` `Abstract` definitions

`Optional` `Abstract` expressionManager

`Readonly` `Abstract` groups

`Readonly` `Abstract` motionDataType

`Readonly` settings

`Static` prefixed

`Protected` `Abstract` _startMotion

`Optional` onFinish: ((motion: Motion) => void)

`Protected` `Abstract` _stopAllMotions

`Optional` context: any

`Abstract` createMotion

`Rest` ...args: any[]

`Abstract` getMotionFile

`Protected` `Abstract` getMotionName

`Protected` `Abstract` getSoundFile

`Protected` init

`Optional` options: MotionManagerOptions

`Abstract` isFinished

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` event: string | symbol

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Protected` setupMotions

`Optional` options: MotionManagerOptions