Class Cubism4InternalModel

A wrapper that manages the states of a Live2D core model, and delegates all operations to it.

Emits

InternalModelEvents

Hierarchy

InternalModel
- Cubism4InternalModel

Constructors

constructor

new Cubism4InternalModel(coreModel: CubismModel, settings: Cubism4ModelSettings, options?: InternalModelOptions): Cubism4InternalModel
Parameters
- coreModel: CubismModel
- settings: Cubism4ModelSettings
- Optional options: InternalModelOptions
Returns Cubism4InternalModel
Overrides InternalModel.constructor
- Defined in src/cubism4/Cubism4InternalModel.ts:65

Properties

breath

breath: CubismBreath = ...

`Protected` centeringTransform

centeringTransform: Matrix = ...

Matrix that scales by pixelsPerUnit, and moves the origin from top-left to center.

FIXME: This shouldn't be named as "centering"...

coreModel

coreModel: CubismModel

The managed Live2D core model.

destroyed

destroyed: boolean = false

Flags this instance has been destroyed.

drawingMatrix

drawingMatrix: Matrix = ...

The final matrix to draw the model.

`Optional` eyeBlink

eyeBlink?: CubismEyeBlink

focusController

focusController: FocusController = ...

`Readonly` height

height: number = 0

Canvas height of the model, scaled by the height of the model's layout.

hitAreas

hitAreas: Record<string, CommonHitArea> = {}

The hit area definitions, keyed by their names.

idParamAngleX

idParamAngleX: string = ParamAngleX

idParamAngleY

idParamAngleY: string = ParamAngleY

idParamAngleZ

idParamAngleZ: string = ParamAngleZ

idParamBodyAngleX

idParamBodyAngleX: string = ParamBodyAngleX

idParamBreath

idParamBreath: string = ParamBreath

idParamEyeBallX

idParamEyeBallX: string = ParamEyeBallX

idParamEyeBallY

idParamEyeBallY: string = ParamEyeBallY

lipSync

lipSync: boolean = true

localTransform

localTransform: Matrix = ...

Local transformation, calculated from the model's layout.

motionManager

motionManager: Cubism4MotionManager

`Readonly` originalHeight

originalHeight: number = 0

Original canvas height of the model. Note this doesn't represent the model's real size, as the model can overflow from its canvas.

`Readonly` originalWidth

originalWidth: number = 0

Original canvas width of the model. Note this doesn't represent the model's real size, as the model can overflow from its canvas.

`Optional` physics

physics?: CubismPhysics

`Readonly` pixelsPerUnit

pixelsPerUnit: number = 1

The model's internal scale, defined in the moc3 file.

textureFlipY

textureFlipY: boolean = false

Flags whether gl.UNPACK_FLIP_Y_WEBGL should be enabled when binding the textures.

`Optional` userData

userData?: CubismModelUserData

viewport

viewport: [number, number, number, number] = ...

WebGL viewport when drawing the model. The format is [x, y, width, height].

`Readonly` width

width: number = 0

Canvas width of the model, scaled by the width of the model's layout.

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener(event: string | symbol, fn: ListenerFn, context?: any): Cubism4InternalModel
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns Cubism4InternalModel
Inherited from InternalModel.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

bindTexture

bindTexture(index: number, texture: WebGLTexture): void
Binds a texture to the model. The index must be the same as that of this texture in the textures array.
Parameters
- index: number
- texture: WebGLTexture
Returns void
Overrides InternalModel.bindTexture
- Defined in src/cubism4/Cubism4InternalModel.ts:140

destroy

destroy(): void
Destroys the model and all related resources.

Emits
destroy

Returns void
Overrides InternalModel.destroy
- Defined in src/cubism4/Cubism4InternalModel.ts:260

draw

draw(gl: WebGLRenderingContext): void
Draws the model.
Parameters
- gl: WebGLRenderingContext
Returns void
Overrides InternalModel.draw
- Defined in src/cubism4/Cubism4InternalModel.ts:243

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 InternalModel.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 InternalModel.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

getDrawableBounds

getDrawableBounds(index: number, bounds?: Bounds): Bounds
Gets a drawable's bounds.

Returns
The bounds in model canvas space.
Parameters
- index: number
  
  Index of the drawable.
- Optional bounds: Bounds
  
  Object to store the output values.
Returns Bounds
Inherited from InternalModel.getDrawableBounds
- Defined in src/cubism-common/InternalModel.ts:212

getDrawableIDs

getDrawableIDs(): string[]
Gets all the drawables' IDs.

Returns
IDs.

Returns string[]
Overrides InternalModel.getDrawableIDs
- Defined in src/cubism4/Cubism4InternalModel.ts:152

getDrawableIndex

getDrawableIndex(id: string): number
Finds the index of a drawable by its ID.

Returns
The index.
Parameters
- id: string
Returns number
Overrides InternalModel.getDrawableIndex
- Defined in src/cubism4/Cubism4InternalModel.ts:156

getDrawableVertices

getDrawableVertices(drawIndex: string | number): Float32Array
Gets a drawable's vertices.

Throws
Error when the drawable cannot be found.
Parameters
- drawIndex: string | number
  
  Either the index or the ID of the drawable.
Returns Float32Array
Overrides InternalModel.getDrawableVertices
- Defined in src/cubism4/Cubism4InternalModel.ts:160

`Protected` getHitAreaDefs

getHitAreaDefs(): CommonHitArea[]
Gets all the hit area definitions.

Returns
Normalized definitions.

Returns CommonHitArea[]
Overrides InternalModel.getHitAreaDefs
- Defined in src/cubism4/Cubism4InternalModel.ts:144

`Protected` getLayout

getLayout(): CommonLayout
Gets the layout definition.

Returns
Normalized definition.

Returns CommonLayout
Overrides InternalModel.getLayout
- Defined in src/cubism4/Cubism4InternalModel.ts:98

`Protected` getSize

getSize(): [number, number]
Gets the model's original canvas size.

Returns
[width, height]

Returns [number, number]
Overrides InternalModel.getSize
- Defined in src/cubism4/Cubism4InternalModel.ts:94

hitTest

hitTest(x: number, y: number): string[]
Hit-test on the model.

Returns
The names of the hit hit areas. Can be empty if none is hit.
Parameters
- x: number
  
  Position in model canvas.
- y: number
  
  Position in model canvas.
Returns string[]
Inherited from InternalModel.hitTest
- Defined in src/cubism-common/InternalModel.ts:183

`Protected` init

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

Returns void
Overrides InternalModel.init
- Defined in src/cubism4/Cubism4InternalModel.ts:75

isHit

isHit(hitAreaName: string, x: number, y: number): boolean
Hit-test for a single hit area.

Returns
True if hit.
Parameters
- hitAreaName: string
  
  The hit area's name.
- x: number
  
  Position in model canvas.
- y: number
  
  Position in model canvas.
Returns boolean
Inherited from InternalModel.isHit
- Defined in src/cubism-common/InternalModel.ts:194

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from InternalModel.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 InternalModel.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

off

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

on

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

once

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

removeAllListeners

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

removeListener

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

`Protected` setupHitAreas

setupHitAreas(): void
Sets up the hit areas by their definitions in settings.

Returns void
Inherited from InternalModel.setupHitAreas
- Defined in src/cubism-common/InternalModel.ts:169

`Protected` setupLayout

setupLayout(): void
Sets up the model's size and local transform by the model's layout.

Returns void
Overrides InternalModel.setupLayout
- Defined in src/cubism4/Cubism4InternalModel.ts:115

update

update(dt: number, now: number): void
Updates the model's parameters.
Parameters
- dt: number
  
  Elapsed time in milliseconds from last frame.
- now: number
  
  Current time in milliseconds.
Returns void
Overrides InternalModel.update
- Defined in src/cubism4/Cubism4InternalModel.ts:184

updateFocus

updateFocus(): void
Returns void
- Defined in src/cubism4/Cubism4InternalModel.ts:230

updateNaturalMovements

updateNaturalMovements(dt: number, now: number): void
Parameters
- dt: number
- now: number
Returns void
- Defined in src/cubism4/Cubism4InternalModel.ts:239

updateTransform

updateTransform(transform: Matrix): void
Updates the model's transform.
Parameters
- transform: Matrix
  
  The world transform.
Returns void
Overrides InternalModel.updateTransform
- Defined in src/cubism4/Cubism4InternalModel.ts:177

updateWebGLContext

updateWebGLContext(gl: WebGLRenderingContext, glContextID: number): void
Updates WebGL context bound to this model.
Parameters
- gl: WebGLRenderingContext
  
  WebGL context.
- glContextID: number
  
  Unique ID for given WebGL context.
Returns void
Overrides InternalModel.updateWebGLContext
- Defined in src/cubism4/Cubism4InternalModel.ts:126

Class Cubism4InternalModel

Emits

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

coreModel: CubismModel

settings: Cubism4ModelSettings

Optional options: InternalModelOptions

Returns Cubism4InternalModel

Properties

breath

Protected centeringTransform

coreModel

destroyed

drawingMatrix

Optional eyeBlink

focusController

Readonly height

hitAreas

idParamAngleX

idParamAngleY

idParamAngleZ

idParamBodyAngleX

idParamBreath

idParamEyeBallX

idParamEyeBallY

lipSync

localTransform

motionManager

Readonly originalHeight

Readonly originalWidth

Optional physics

Readonly pixelsPerUnit

Optional pose

renderer

settings

textureFlipY

Optional userData

viewport

Readonly width

Static prefixed

Methods

addListener

Parameters

event: string | symbol

fn: ListenerFn

Optional context: any

Returns Cubism4InternalModel

bindTexture

Parameters

index: number

texture: WebGLTexture

Returns void

destroy

Emits

Returns void

draw

Parameters

gl: WebGLRenderingContext

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getDrawableBounds

Returns

Parameters

index: number

Optional bounds: Bounds

Returns Bounds

getDrawableIDs

Returns

`Optional` options: InternalModelOptions

`Protected` centeringTransform

`Optional` eyeBlink

`Readonly` height

`Readonly` originalHeight

`Readonly` originalWidth

`Optional` physics

`Readonly` pixelsPerUnit

`Optional` pose

`Optional` userData

`Readonly` width

`Static` prefixed

`Optional` context: any

`Rest` ...args: any[]

`Optional` bounds: Bounds

`Protected` getHitAreaDefs

`Protected` getLayout

`Protected` getSize

`Protected` init

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` event: string | symbol

`Optional` fn: ListenerFn