API / ArmatureData

Class: ArmatureData

Defined in: model/ArmatureData.ts:41

The armature data.

Extends

• BaseObject

Constructors

Constructor

new ArmatureData(): ArmatureData;

Returns

ArmatureData

Inherited from

BaseObject.constructor

Properties

animationNames

readonly animationNames: string[] = [];

Defined in: model/ArmatureData.ts:84

The names of all the animation data.

---

defaultAnimation

defaultAnimation: AnimationData;

Defined in: model/ArmatureData.ts:136

The default animation data.

---

defaultSkin

defaultSkin: SkinData;

Defined in: model/ArmatureData.ts:128

The default skin data.

---

frameRate

frameRate: number;

Defined in: model/ArmatureData.ts:56

The animation frame rate.

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode

---

name

name: string;

Defined in: model/ArmatureData.ts:72

The armature name.

Methods

addAction()

addAction(value: ActionData, isDefault: boolean): void;

Defined in: model/ArmatureData.ts:383

Internal

Parameters

Parameter	Type
value	ActionData
isDefault	boolean

Returns

void

---

addAnimation()

addAnimation(value: AnimationData): void;

Defined in: model/ArmatureData.ts:367

Internal

Parameters

Parameter	Type
value	AnimationData

Returns

void

---

addBone()

addBone(value: BoneData): void;

Defined in: model/ArmatureData.ts:313

Internal

Parameters

Parameter	Type
value	BoneData

Returns

void

---

addConstraint()

addConstraint(value: ConstraintData): void;

Defined in: model/ArmatureData.ts:337

Internal

Parameters

Parameter	Type
value	ConstraintData

Returns

void

---

addSkin()

addSkin(value: SkinData): void;

Defined in: model/ArmatureData.ts:348

Internal

Parameters

Parameter	Type
value	SkinData

Returns

void

---

addSlot()

addSlot(value: SlotData): void;

Defined in: model/ArmatureData.ts:325

Internal

Parameters

Parameter	Type
value	SlotData

Returns

void

---

cacheFrames()

cacheFrames(frameRate: number): void;

Defined in: model/ArmatureData.ts:261

Internal

Parameters

Parameter	Type
frameRate	number

Returns

void

---

getAnimation()

getAnimation(animationName: string): AnimationData;

Defined in: model/ArmatureData.ts:453

Get a specific animation data.

Parameters

Parameter	Type	Description
animationName	string	The animation animationName.

Returns

AnimationData

---

getBone()

getBone(boneName: string): BoneData;

Defined in: model/ArmatureData.ts:399

Get a specific done data.

Parameters

Parameter	Type	Description
boneName	string	The bone name.

Returns

BoneData

---

getCacheFrame()

getCacheFrame(
   globalTransformMatrix: Matrix, 
   transform: Transform, 
   arrayOffset: number): void;

Defined in: model/ArmatureData.ts:295

Internal

Parameters

Parameter	Type
globalTransformMatrix	Matrix
transform	Transform
arrayOffset	number

Returns

void

---

getSkin()

getSkin(skinName: string): SkinData;

Defined in: model/ArmatureData.ts:429

Get a specific skin data.

Parameters

Parameter	Type	Description
skinName	string	The skin name.

Returns

SkinData

---

getSlot()

getSlot(slotName: string): SlotData;

Defined in: model/ArmatureData.ts:410

Get a specific slot data.

Parameters

Parameter	Type	Description
slotName	string	The slot name.

Returns

SlotData

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

BaseObject.returnToPool

---

setCacheFrame()

setCacheFrame(globalTransformMatrix: Matrix, transform: Transform): number;

Defined in: model/ArmatureData.ts:274

Internal

Parameters

Parameter	Type
globalTransformMatrix	Matrix
transform	Transform

Returns

number

---

sortBones()

sortBones(): void;

Defined in: model/ArmatureData.ts:217

Internal

Returns

void

---

borrowObject()

static borrowObject<T>(objectConstructor: () => T): T;

Defined in: core/BaseObject.ts:136

Get an instance of the specify class from object pool.

Type Parameters

Type Parameter
T extends BaseObject

Parameters

Parameter	Type	Description
objectConstructor	() => T	The specify class.

Returns

T

Inherited from

BaseObject.borrowObject

---

clearPool()

static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

Parameter	Type	Default value	Description
objectConstructor	typeof BaseObject	null	Specify class. (Clear all cached instances if not set)

Returns

void

Inherited from

BaseObject.clearPool

---

setMaxCount()

static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;

Defined in: core/BaseObject.ts:72

Set the maximum cache count of the specify object pool.

Parameters

Parameter	Type	Description
objectConstructor	typeof BaseObject	The specify class. (Set all object pools max cache count if not set)
maxCount	number	Max count.

Returns

void

Inherited from

BaseObject.setMaxCount

---

toString()

static toString(): string;

Defined in: model/ArmatureData.ts:42

Returns

string

Overrides

BaseObject.toString