API / Constraint

Class: abstract Constraint

Defined in: armature/Constraint.ts:34

Internal

Extends

• BaseObject

Extended by

• IKConstraint
• PathConstraint

Constructors

Constructor

new Constraint(): Constraint;

Returns

Constraint

Inherited from

BaseObject.constructor

Properties

_constraintData

_constraintData: ConstraintData;

Defined in: armature/Constraint.ts:42

Internal

• For timeline state.

---

_root

_root: Bone;

Defined in: armature/Constraint.ts:53

Internal

• For sort bones.

---

_target

_target: Bone;

Defined in: armature/Constraint.ts:48

Internal

• For sort bones.

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode

Accessors

name

Get Signature

get name(): string;

Defined in: armature/Constraint.ts:67

Returns

string

Methods

init()

abstract init(constraintData: ConstraintData, armature: Armature): void;

Defined in: armature/Constraint.ts:63

Parameters

Parameter	Type
constraintData	ConstraintData
armature	Armature

Returns

void

---

invalidUpdate()

abstract invalidUpdate(): void;

Defined in: armature/Constraint.ts:65

Returns

void

---

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

---

update()

abstract update(): void;

Defined in: armature/Constraint.ts:64

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: core/BaseObject.ts:56

Returns

string

Inherited from

BaseObject.toString