API / IKConstraint

Class: IKConstraint

Defined in: armature/Constraint.ts:74

Internal

Extends

• Constraint

Constructors

Constructor

new IKConstraint(): IKConstraint;

Returns

IKConstraint

Inherited from

Constraint.constructor

Properties

_bendPositive

_bendPositive: boolean;

Defined in: armature/Constraint.ts:84

Internal

• For timeline state.

---

_constraintData

_constraintData: ConstraintData;

Defined in: armature/Constraint.ts:42

Internal

• For timeline state.

Inherited from

Constraint._constraintData

---

_root

_root: Bone;

Defined in: armature/Constraint.ts:53

Internal

• For sort bones.

Inherited from

Constraint._root

---

_target

_target: Bone;

Defined in: armature/Constraint.ts:48

Internal

• For sort bones.

Inherited from

Constraint._target

---

_weight

_weight: number;

Defined in: armature/Constraint.ts:89

Internal

• For timeline state.

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

Constraint.hashCode

Accessors

name

Get Signature

get name(): string;

Defined in: armature/Constraint.ts:67

Returns

string

Inherited from

Constraint.name

Methods

init()

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

Defined in: armature/Constraint.ts:192

Parameters

Parameter	Type
constraintData	ConstraintData
armature	Armature

Returns

void

Overrides

Constraint.init

---

invalidUpdate()

invalidUpdate(): void;

Defined in: armature/Constraint.ts:225

Returns

void

Overrides

Constraint.invalidUpdate

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

Constraint.returnToPool

---

update()

update(): void;

Defined in: armature/Constraint.ts:213

Returns

void

Overrides

Constraint.update

---

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

Constraint.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

Constraint.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

Constraint.setMaxCount

---

toString()

static toString(): string;

Defined in: armature/Constraint.ts:75

Returns

string

Overrides

Constraint.toString