Class InternalModel`Abstract`

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

Emits

InternalModelEvents

Hierarchy

EventEmitter
- InternalModel
  - Cubism2InternalModel
  - Cubism4InternalModel

Constructors

constructor

new InternalModel(): InternalModel
Returns InternalModel

Inherited from EventEmitter.constructor

Properties

`Readonly` `Abstract` coreModel

coreModel: object

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.

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.

localTransform

localTransform: Matrix = ...

Local transformation, calculated from the model's layout.

`Abstract` motionManager

motionManager: MotionManager<any, any>

`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?: any

`Optional` pose

pose?: any

`Readonly` `Abstract` settings

settings: ModelSettings

textureFlipY

textureFlipY: boolean = false

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

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): InternalModel
Parameters
- event: string | symbol
- fn: ListenerFn
- Optional context: any
Returns InternalModel
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

`Abstract` 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
- Defined in src/cubism-common/InternalModel.ts:317

destroy

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

Emits
destroy

Returns void
- Defined in src/cubism-common/InternalModel.ts:261

`Abstract` draw

draw(gl: WebGLRenderingContext): void
Draws the model.
Parameters
- gl: WebGLRenderingContext
Returns void
- Defined in src/cubism-common/InternalModel.ts:322

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

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
- Defined in src/cubism-common/InternalModel.ts:212

`Abstract` getDrawableIDs

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

Returns
IDs.

Returns string[]
- Defined in src/cubism-common/InternalModel.ts:291

`Abstract` getDrawableIndex

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

Returns
The index.
Parameters
- id: string
Returns number
- Defined in src/cubism-common/InternalModel.ts:297

`Abstract` getDrawableVertices

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

Throws
Error when the drawable cannot be found.
Parameters
- index: string | number
  
  Either the index or the ID of the drawable.
Returns Float32Array
- Defined in src/cubism-common/InternalModel.ts:304

`Protected` `Abstract` getHitAreaDefs

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

Returns
Normalized definitions.

Returns CommonHitArea[]
- Defined in src/cubism-common/InternalModel.ts:273

`Protected` `Abstract` getLayout

getLayout(): CommonLayout
Gets the layout definition.

Returns
Normalized definition.

Returns CommonLayout
- Defined in src/cubism-common/InternalModel.ts:285

`Protected` `Abstract` getSize

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

Returns
[width, height]

Returns [number, number]
- Defined in src/cubism-common/InternalModel.ts:279

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[]
- Defined in src/cubism-common/InternalModel.ts:183

`Protected` init

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

Returns void
- Defined in src/cubism-common/InternalModel.ts:120

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
- 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 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

off

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

on

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

once

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

removeAllListeners

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

removeListener

removeListener(event: string | symbol, fn?: ListenerFn, context?: any, once?: boolean): InternalModel
Remove the listeners of a given event.
Parameters
- event: string | symbol
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns InternalModel
Inherited from EventEmitter.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
- 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
- Defined in src/cubism-common/InternalModel.ts:128

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
- Defined in src/cubism-common/InternalModel.ts:253

updateTransform

updateTransform(transform: Matrix): void
Updates the model's transform.
Parameters
- transform: Matrix
  
  The world transform.
Returns void
- Defined in src/cubism-common/InternalModel.ts:244

`Abstract` 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
- Defined in src/cubism-common/InternalModel.ts:311

Class InternalModelAbstract

Emits

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns InternalModel

Properties

Readonly Abstract coreModel

destroyed

drawingMatrix

focusController

Readonly height

hitAreas

localTransform

Abstract motionManager

Readonly originalHeight

Readonly originalWidth

Optional physics

Optional pose

Readonly Abstract settings

textureFlipY

viewport

Readonly width

Static prefixed

Methods

addListener

Parameters

event: string | symbol

fn: ListenerFn

Optional context: any

Returns InternalModel

Abstract bindTexture

Parameters

index: number

texture: WebGLTexture

Returns void

destroy

Emits

Returns void

Abstract 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

Abstract getDrawableIDs

Returns

Returns string[]

Abstract getDrawableIndex

Returns

Parameters

id: string

Returns number

Abstract getDrawableVertices

Throws

Parameters

index: string | number

Returns Float32Array

Protected Abstract getHitAreaDefs

Returns

Returns CommonHitArea[]

Protected Abstract getLayout

Returns

Returns CommonLayout

Protected Abstract getSize

Class InternalModel`Abstract`

`Readonly` `Abstract` coreModel

`Readonly` height

`Abstract` motionManager

`Readonly` originalHeight

`Readonly` originalWidth

`Optional` physics

`Optional` pose

`Readonly` `Abstract` settings

`Readonly` width

`Static` prefixed

`Optional` context: any

`Abstract` bindTexture

`Abstract` draw

`Rest` ...args: any[]

`Optional` bounds: Bounds

`Abstract` getDrawableIDs

`Abstract` getDrawableIndex

`Abstract` getDrawableVertices

`Protected` `Abstract` getHitAreaDefs

`Protected` `Abstract` getLayout

`Protected` `Abstract` 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

`Optional` context: any

`Optional` once: boolean

`Protected` setupHitAreas

`Protected` setupLayout

`Abstract` updateWebGLContext