Class Cubism4ExpressionManager

Abstract expression manager.

Emits

ExpressionManagerEvents

Hierarchy

ExpressionManager<CubismExpressionMotion, Expression>
- Cubism4ExpressionManager

Constructors

constructor

new Cubism4ExpressionManager(settings: Cubism4ModelSettings, options?: MotionManagerOptions): Cubism4ExpressionManager
Parameters
- settings: Cubism4ModelSettings
- Optional options: MotionManagerOptions
Returns Cubism4ExpressionManager
Overrides ExpressionManager.constructor
- Defined in src/cubism4/Cubism4ExpressionManager.ts:14

Properties

currentExpression

currentExpression: CubismExpressionMotion

Current Expression. This will not be overwritten by defaultExpression.

defaultExpression

defaultExpression: CubismExpressionMotion

An empty Expression to reset all the expression parameters.

`Readonly` definitions

definitions: Expression[]

Expression definitions copied from ModelSettings.

destroyed

destroyed: boolean = false

Flags the instance has been destroyed.

expressions

expressions: (undefined | null | CubismExpressionMotion)[] = []

The Expressions. The structure is the same as definitions, initially there's only an empty array, which means all expressions will be undefined. When an Expression 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.

`Readonly` queueManager

queueManager: CubismMotionQueueManager = ...

reserveExpressionIndex

reserveExpressionIndex: number = -1

The pending Expression.

`Readonly` settings

settings: ModelSettings

The ModelSettings reference.

tag

tag: string

Tag for logging.

`Static` prefixed

prefixed: string | boolean

Methods

`Protected` _setExpression

_setExpression(motion: CubismExpressionMotion): number
Applies the Expression to the model.
Parameters
- motion: CubismExpressionMotion
Returns number
Overrides ExpressionManager._setExpression
- Defined in src/cubism4/Cubism4ExpressionManager.ts:38

addListener

addListener(event: keyof ExpressionManagerEvents<any>, fn: ListenerFn, context?: any): Cubism4ExpressionManager
Parameters
- event: keyof ExpressionManagerEvents<any>
- fn: ListenerFn
- Optional context: any
Returns Cubism4ExpressionManager
Inherited from ExpressionManager.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

createExpression

createExpression(data: object, definition: undefined | Expression): CubismExpressionMotion
Creates an Expression from the data.

Returns
The created Expression.
Parameters
- data: object
  
  Content of the expression file.
- definition: undefined | Expression
  
  The expression definition. Can be undefined in order to create defaultExpression.
Returns CubismExpressionMotion
Overrides ExpressionManager.createExpression
- Defined in src/cubism4/Cubism4ExpressionManager.ts:34

destroy

destroy(): void
Destroys the instance.

Emits
destroy

Returns void
Inherited from ExpressionManager.destroy
- Defined in src/cubism-common/ExpressionManager.ts:201

emit

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

eventNames

eventNames(): (keyof ExpressionManagerEvents<any>)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof ExpressionManagerEvents<any>)[]
Inherited from ExpressionManager.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

getExpressionFile

getExpressionFile(definition: Expression): string
Retrieves the expression's file path by its definition.

Returns
The file path extracted from given definition. Not resolved.
Parameters
- definition: Expression
Returns string
Overrides ExpressionManager.getExpressionFile
- Defined in src/cubism4/Cubism4ExpressionManager.ts:30

getExpressionIndex

getExpressionIndex(name: string): number
Retrieves the expression's index by its name.

Returns
The index. -1 if not found.
Parameters
- name: string
Returns number
Overrides ExpressionManager.getExpressionIndex
- Defined in src/cubism4/Cubism4ExpressionManager.ts:26

`Protected` init

init(): void
Should be called in the constructor of derived class.

Returns void
Inherited from ExpressionManager.init
- Defined in src/cubism-common/ExpressionManager.ts:65

isFinished

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

Returns boolean
Overrides ExpressionManager.isFinished
- Defined in src/cubism4/Cubism4ExpressionManager.ts:22

listenerCount

listenerCount(event: keyof ExpressionManagerEvents<any>): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof ExpressionManagerEvents<any>
Returns number
Inherited from ExpressionManager.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:22

listeners

listeners(event: keyof ExpressionManagerEvents<any>): ListenerFn[]
Return the listeners registered for a given event.
Parameters
- event: keyof ExpressionManagerEvents<any>
Returns ListenerFn[]
Inherited from ExpressionManager.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

`Protected` loadExpression

loadExpression(index: number): Promise<undefined | CubismExpressionMotion>
Loads an Expression. Errors in this method will not be thrown, but be emitted with an "expressionLoadError" event.

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

Emits
expressionLoaded

Emits
expressionLoadError
Parameters
- index: number
  
  Index of the expression in definitions.
Returns Promise<undefined | CubismExpressionMotion>
Inherited from ExpressionManager.loadExpression
- Defined in src/cubism-common/ExpressionManager.ts:80

off

off(event: keyof ExpressionManagerEvents<any>, fn?: ListenerFn, context?: any, once?: boolean): Cubism4ExpressionManager
Parameters
- event: keyof ExpressionManagerEvents<any>
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns Cubism4ExpressionManager
Inherited from ExpressionManager.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

on(event: keyof ExpressionManagerEvents<any>, fn: ListenerFn, context?: any): Cubism4ExpressionManager
Add a listener for a given event.
Parameters
- event: keyof ExpressionManagerEvents<any>
- fn: ListenerFn
- Optional context: any
Returns Cubism4ExpressionManager
Inherited from ExpressionManager.on
- Defined in node_modules/eventemitter3/index.d.ts:32

once

once(event: keyof ExpressionManagerEvents<any>, fn: ListenerFn, context?: any): Cubism4ExpressionManager
Add a one-time listener for a given event.
Parameters
- event: keyof ExpressionManagerEvents<any>
- fn: ListenerFn
- Optional context: any
Returns Cubism4ExpressionManager
Inherited from ExpressionManager.once
- Defined in node_modules/eventemitter3/index.d.ts:38

removeAllListeners

removeAllListeners(event?: keyof ExpressionManagerEvents<any>): Cubism4ExpressionManager
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof ExpressionManagerEvents<any>
Returns Cubism4ExpressionManager
Inherited from ExpressionManager.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49

removeListener

removeListener(event: keyof ExpressionManagerEvents<any>, fn?: ListenerFn, context?: any, once?: boolean): Cubism4ExpressionManager
Remove the listeners of a given event.
Parameters
- event: keyof ExpressionManagerEvents<any>
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns Cubism4ExpressionManager
Inherited from ExpressionManager.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43

resetExpression

resetExpression(): void
Resets model's expression using defaultExpression.

Returns void
Inherited from ExpressionManager.resetExpression
- Defined in src/cubism-common/ExpressionManager.ts:141

restoreExpression

restoreExpression(): void
Restores model's expression to currentExpression.

Returns void
Inherited from ExpressionManager.restoreExpression
- Defined in src/cubism-common/ExpressionManager.ts:148

setExpression

setExpression(index: string | number): Promise<boolean>
Sets an Expression.

Returns
Promise that resolves with true if succeeded, with false otherwise.
Parameters
- index: string | number
  
  Either the index, or the name of the expression.
Returns Promise<boolean>
Inherited from ExpressionManager.setExpression
- Defined in src/cubism-common/ExpressionManager.ts:157

setRandomExpression

setRandomExpression(): Promise<boolean>
Sets a random Expression that differs from current one.

Returns
Promise that resolves with true if succeeded, with false otherwise.

Returns Promise<boolean>
Inherited from ExpressionManager.setRandomExpression
- Defined in src/cubism-common/ExpressionManager.ts:114

`Protected` stopAllExpressions

stopAllExpressions(): void
Cancels expression playback.

Returns void
Overrides ExpressionManager.stopAllExpressions
- Defined in src/cubism4/Cubism4ExpressionManager.ts:42

update

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

Returns
True if the parameters are actually updated.
Parameters
- model: object
- now: number
Returns boolean
Inherited from ExpressionManager.update
- Defined in src/cubism-common/ExpressionManager.ts:189

`Protected` updateParameters

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

Returns
True if the parameters are actually updated.
Parameters
- model: CubismModel
- now: number
Returns boolean
Overrides ExpressionManager.updateParameters
- Defined in src/cubism4/Cubism4ExpressionManager.ts:46

Class Cubism4ExpressionManager

Emits

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

settings: Cubism4ModelSettings

Optional options: MotionManagerOptions

Returns Cubism4ExpressionManager

Properties

currentExpression

defaultExpression

Readonly definitions

destroyed

expressions

Readonly queueManager

reserveExpressionIndex

Readonly settings

tag

Static prefixed

Methods

Protected _setExpression

Parameters

motion: CubismExpressionMotion

Returns number

addListener

Parameters

event: keyof ExpressionManagerEvents<any>

fn: ListenerFn

Optional context: any

Returns Cubism4ExpressionManager

createExpression

Returns

Parameters

data: object

definition: undefined | Expression

Returns CubismExpressionMotion

destroy

Emits

Returns void

emit

Parameters

event: keyof ExpressionManagerEvents<any>

Rest ...args: any[]

Returns boolean

eventNames

Returns (keyof ExpressionManagerEvents<any>)[]

getExpressionFile

Returns

Parameters

definition: Expression

Returns string

getExpressionIndex

Returns

Parameters

name: string

Returns number

Protected init

Returns void

isFinished

Returns boolean

listenerCount

Parameters

event: keyof ExpressionManagerEvents<any>

Returns number

listeners

Parameters

event: keyof ExpressionManagerEvents<any>

Returns ListenerFn[]

Protected loadExpression

Returns

Emits

Emits

Parameters

index: number

Returns Promise<undefined | CubismExpressionMotion>

`Optional` options: MotionManagerOptions

`Readonly` definitions

`Readonly` queueManager

`Readonly` settings

`Static` prefixed

`Protected` _setExpression

`Optional` context: any

`Rest` ...args: any[]

`Protected` init

`Protected` loadExpression

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` event: keyof ExpressionManagerEvents<any>

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Protected` stopAllExpressions

`Protected` updateParameters