Skip to main content

SpineController

Query and utility layer over the spine registry — bone/slot lookups, world-space positions, texture extraction, and cloning. Accessed via layout.spine.

Methods​

clone​

clone(spine: Spine, newSpineID: string): Spine

Clones a Spine instance, registers it under newSpineID, and offsets its position by 100px so it does not overlap the source.

cloneBySpineID​

cloneBySpineID(spineID: string, newSpineID: string): Spine | null

Looks up a registered spine by ID then clones it. Returns null if the source spine is not found.

getBonesByNamePattern​

getBonesByNamePattern(pattern: string): BoneData[]

Returns all bone definitions whose names start with pattern, across all registered spines.

getSlotsByNamePattern​

getSlotsByNamePattern(pattern: string): SlotData[]

Returns all slot definitions whose names start with pattern, across all registered spines.

getSlotByName​

getSlotByName(name: string): Slot | undefined

Finds the first live slot with the given name across all registered spines.

idOf​

idOf(spine: Spine): string | undefined

The id a spine is registered under — the same string the layout sets as the instance's label (name on PIXI v4) when it builds it — or undefined for a spine the layout does not hold.

getSpinesByNamePattern​

getSpinesByNamePattern(pattern: string, options?: { not?: string[] }): Map<string, Spine>

Returns all registered spines whose IDs start with pattern. Pass options.not to exclude IDs containing those substrings.

getBoneGlobalPosition​

getBoneGlobalPosition(spineID: string, boneName: string): Point | undefined

Returns the world-space position of the first bone matching boneName on the given spine.

getBonesGlobalPositionsByNamePattern​

getBonesGlobalPositionsByNamePattern(pattern: string): Record<string, Point>

Returns a name→Point map of world-space positions for all bones matching the prefix, across all spines.

getSlotsGlobalPositionsByNamePattern​

getSlotsGlobalPositionsByNamePattern(pattern: string): Record<string, Point>

Returns a name→Point map of world-space positions for all slots matching the prefix, across all spines.

getSlotTexture​

getSlotTexture(spineName: string, slotName: string): Texture | null

Extracts the Pixi.js Texture from a slot's attachment. Returns null if the slot has no region/mesh attachment.