Pixi’VNAbstract Class: InternalModel
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3145
A wrapper that manages the states of a Live2D core model, and delegates all operations to it.
Emits
Extends
EventEmitter
Extended by
Constructors
Constructor
> new InternalModel(): InternalModel
Returns
InternalModel
Inherited from
EventEmitter.constructor
Properties
coreModel
> abstract readonly coreModel: object
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3149
The managed Live2D core model.
destroyed
> destroyed: boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3203
Flags this instance has been destroyed.
drawingMatrix
> drawingMatrix: Matrix
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3182
The final matrix to draw the model.
focusController
> focusController: FocusController
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3152
height
> readonly height: number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3174
Canvas height of the model, scaled by the height of the model's layout.
hitAreas
> hitAreas: Record<string, CommonHitArea>
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3186
The hit area definitions, keyed by their names.
localTransform
> localTransform: Matrix
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3178
Local transformation, calculated from the model's layout.
motionManager
> abstract motionManager: MotionManager
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3153
options
> abstract readonly options: InternalModelOptions
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3151
originalHeight
> readonly originalHeight: number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3166
Original canvas height of the model. Note this doesn't represent the model's real size, as the model can overflow from its canvas.
originalWidth
> readonly originalWidth: number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3161
Original canvas width of the model. Note this doesn't represent the model's real size, as the model can overflow from its canvas.
parallelMotionManager
> abstract parallelMotionManager: ParallelMotionManager<Live2DMotion | CubismMotion, never>[]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3154
physics?
> optional physics?: unknown
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3156
pose?
> optional pose?: unknown
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3155
settings
> abstract readonly settings: ModelSettings
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3150
textureFlipY
> textureFlipY: boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3190
Flags whether gl.UNPACK_FLIP_Y_WEBGL should be enabled when binding the textures.
viewport
> viewport: [number, number, number, number]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3194
WebGL viewport when drawing the model. The format is [x, y, width, height].
width
> readonly width: number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3170
Canvas width of the model, scaled by the width of the model's layout.
prefixed
> static prefixed: string | boolean
Defined in: node_modules/eventemitter3/index.d.ts:9
Inherited from
EventEmitter.prefixed
Methods
addListener()
> addListener<T>(event, fn, context?): this
Defined in: node_modules/eventemitter3/index.d.ts:45
Type Parameters
T
T extends string | symbol
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.addListener
bindTexture()
> abstract bindTexture(index, texture): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3315
Binds a texture to the model. The index must be the same as that of this texture in the ModelSettings.textures array.
Parameters
index
number
texture
WebGLTexture
Returns
void
destroy()
> destroy(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3253
Destroys the model and all related resources.
Returns
void
Emits
`InternalModelEvents.destroy` | destroy
draw()
> abstract draw(gl): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3319
Draws the model.
Parameters
gl
WebGLRenderingContext
Returns
void
emit()
> emit<T>(event, ...args): boolean
Defined in: node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.
Type Parameters
T
T extends string | symbol
Parameters
event
T
args
...any[]
Returns
boolean
Inherited from
EventEmitter.emit
eventNames()
> eventNames(): (string | symbol)[]
Defined in: node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.
Returns
(string | symbol)[]
Inherited from
EventEmitter.eventNames
extendParallelMotionManager()
> abstract extendParallelMotionManager(managerCount): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3324
Add parallel motion manager.
Parameters
managerCount
number
Count of parallel motion managers.
Returns
void
getDrawableBounds()
> getDrawableBounds(index, bounds?): Bounds
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3237
Gets a drawable's bounds.
Parameters
index
number
Index of the drawable.
bounds?
Bounds
Object to store the output values.
Returns
Bounds
The bounds in model canvas space.
getDrawableIDs()
> abstract getDrawableIDs(): string[]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3293
Gets all the drawables' IDs.
Returns
string[]
IDs.
getDrawableIndex()
> abstract getDrawableIndex(id): number
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3298
Finds the index of a drawable by its ID.
Parameters
id
string
Returns
number
The index.
getDrawableVertices()
> abstract getDrawableVertices(index): Float32Array
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3304
Gets a drawable's vertices.
Parameters
index
string | number
Either the index or the ID of the drawable.
Returns
Float32Array
Throws
Error when the drawable cannot be found.
getHitAreaDefs()
> abstract protected getHitAreaDefs(): CommonHitArea[]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3275
Gets all the hit area definitions.
Returns
Normalized definitions.
getLayout()
> abstract protected getLayout(): CommonLayout
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3288
Gets the layout definition.
Returns
Normalized definition.
getSize()
> abstract protected getSize(): [number, number]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3280
Gets the model's original canvas size.
Returns
[number, number]
[width, height]
hitTest()
> hitTest(x, y): string[]
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3222
Hit-test on the model.
Parameters
x
number
Position in model canvas.
y
number
Position in model canvas.
Returns
string[]
The names of the hit hit areas. Can be empty if none is hit.
init()
> protected init(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3207
Should be called in the constructor of derived class.
Returns
void
isHit()
> isHit(hitAreaName, x, y): boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3230
Hit-test for a single hit area.
Parameters
hitAreaName
string
The hit area's name.
x
number
Position in model canvas.
y
number
Position in model canvas.
Returns
boolean
True if hit.
listenerCount()
> listenerCount(event): number
Defined in: node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.
Parameters
event
string | symbol
Returns
number
Inherited from
EventEmitter.listenerCount
listeners()
> listeners<T>(event): (...args) => void[]
Defined in: node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.
Type Parameters
T
T extends string | symbol
Parameters
event
T
Returns
(...args) => void[]
Inherited from
EventEmitter.listeners
off()
> off<T>(event, fn?, context?, once?): this
Defined in: node_modules/eventemitter3/index.d.ts:69
Type Parameters
T
T extends string | symbol
Parameters
event
T
fn?
(...args) => void
context?
any
once?
boolean
Returns
this
Inherited from
EventEmitter.off
on()
> on<T>(event, fn, context?): this
Defined in: node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.
Type Parameters
T
T extends string | symbol
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.on
once()
> once<T>(event, fn, context?): this
Defined in: node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.
Type Parameters
T
T extends string | symbol
Parameters
event
T
fn
(...args) => void
context?
any
Returns
this
Inherited from
EventEmitter.once
removeAllListeners()
> removeAllListeners(event?): this
Defined in: node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.
Parameters
event?
string | symbol
Returns
this
Inherited from
EventEmitter.removeAllListeners
removeListener()
> removeListener<T>(event, fn?, context?, once?): this
Defined in: node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.
Type Parameters
T
T extends string | symbol
Parameters
event
T
fn?
(...args) => void
context?
any
once?
boolean
Returns
this
Inherited from
EventEmitter.removeListener
setupHitAreas()
> protected setupHitAreas(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3215
Sets up the hit areas by their definitions in settings.
Returns
void
setupLayout()
> protected setupLayout(): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3211
Sets up the model's size and local transform by the model's layout.
Returns
void
update()
> update(dt, _now): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3248
Updates the model's parameters.
Parameters
dt
number
Elapsed time in milliseconds from last frame.
_now
number
Current time in milliseconds.
Returns
void
updateMotions()
> protected updateMotions(model, now): boolean
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3270
Updates all active motions for the model and emits lifecycle events.
This method coordinates the update cycle for both primary and parallel motion managers, ensuring all animations are synchronized with the current timestamp. It emits events before and after the update process, allowing external listeners to hook into the motion lifecycle. The return value indicates whether any motion was actively updated during this cycle.
Parameters
model
object
The model instance to apply motion updates to.
now
number
The current timestamp (in milliseconds) used to calculate motion progress.
Returns
boolean
Returns true if any motion (primary or parallel) was updated; false otherwise.
Emits
beforeMotionUpdate - Triggered before any motion updates are processed.
Emits
afterMotionUpdate - Triggered after all motion updates are completed.
updateTransform()
> updateTransform(transform): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3242
Updates the model's transform.
Parameters
transform
Matrix
The world transform.
Returns
void
updateWebGLContext()
> abstract updateWebGLContext(gl, glContextID): void
Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3310
Updates WebGL context bound to this model.
Parameters
gl
WebGLRenderingContext
WebGL context.
glContextID
number
Unique ID for given WebGL context.
Returns
void