Zernikalos/zernikalos.components.skeleton/ZSkinning

ZSkinning

@Serializable(with = ZSkinningSerializer::class)

class ZSkinning : ZSerializableComponent<ZSkinningData> (source)

Skin binding between a mesh and a skeleton for skeletal animation.

Holds the list of bone IDs that influence the mesh, their per-bone inverse bind matrices, and an optional skin-level bind matrix pair used when the mesh node and skeleton root do not share the same transform (e.g. in glTF when skin and mesh are on different nodes).

Typically created by loaders/exporters and attached to a ZModel together with a ZSkeleton.

GPU joint order (per skinned ZModel): boneIds defines the row order of the joint palette for that mesh. ZBoneMatrixGenerator collects each joint’s current world pose (ZBone.poseMatrix) in that same order. ZInverseBindMatrixGenerator fills the matching inverse-bind uniform from inverseBindMatrices by index, or falls back to ZBone.inverseBindMatrix when a skin entry is missing — loaders should keep boneIds and inverseBindMatrices aligned. ZModelSkinningMatrixGenerator supplies modelSkinBindMatrix / mesh–skeleton node offset separately.

Constructors

ZSkinning

constructor()

Properties

boneIds

val boneIds: Array<String>

Ordered list of bone IDs that influence this skin. Order must match inverseBindMatrices.

data

override val data: ZSkinningData

Provides access to the component's serializable data.

inverseBindMatrices

val inverseBindMatrices: Array<ZMatrix4>

Per-bone inverse bind matrices (bind pose bone world → bone local). One per entry in boneIds.

inverseModelSkinBindMatrix

val inverseModelSkinBindMatrix: ZMatrix4

Inverse of modelSkinBindMatrix. Transforms from skeleton space back to mesh local space.

isDisposed

val isDisposed: Boolean

isInitialized

override val isInitialized: Boolean

Represents a boolean value indicating whether a component has been initialized.

isRenderizable

override val isRenderizable: Boolean

Represents a boolean value indicating whether a component is renderizable.

modelSkinBindMatrix

var modelSkinBindMatrix: ZMatrix4

Transform from mesh local space to skeleton (bind) space at bind time. Use identity when the mesh and skeleton share the same node; set from asset data when they differ (e.g. glTF skin on a different node than the mesh).

refId

override val refId: String

Represents the unique identifier for a reference-based component. The refId is used as a distinctive key for retrieving or linking this component within reference-dependent systems.

Functions

addBoneId

fun addBoneId(boneId: String)

Appends a bone ID to the skin.

addInverseBindMatrices

fun addInverseBindMatrices(matrices: List<ZMatrix4>)

Appends all matrices to the inverse bind matrix list. Order must match boneIds.

addInverseBindMatrix

fun addInverseBindMatrix(matrix: ZMatrix4)

Appends a single inverse bind matrix. Order must match boneIds.

fun addInverseBindMatrix(idx: Int, matrix: ZMatrix4)

Inserts matrix at idx in the inverse bind matrix list.

dispose

open override fun dispose()

Disposes the component and releases resources. Idempotent: multiple calls are safe. Subclasses with own state to release should override internalDispose.

initialize

open override fun initialize(ctx: ZRenderingContext)

Initializes the ZComponent using the provided ZRenderingContext.

removeBoneId

fun removeBoneId(boneId: String)

Removes the first occurrence of boneId from the skin.