API / PathConstraintData

Class: PathConstraintData

Defined in: model/ConstraintData.ts:71

Internal

Constructors

Constructor

new PathConstraintData(): PathConstraintData;

Returns

PathConstraintData

Inherited from

ConstraintData.constructor

Properties

bone

bone: BoneData;

Defined in: model/ConstraintData.ts:37

Inherited from

ConstraintData.bone

---

bones

bones: BoneData[] = [];

Defined in: model/ConstraintData.ts:78

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

ConstraintData.hashCode

---

name

name: string;

Defined in: model/ConstraintData.ts:33

Inherited from

ConstraintData.name

---

order

order: number;

Defined in: model/ConstraintData.ts:32

Inherited from

ConstraintData.order

---

pathDisplayData

pathDisplayData: PathDisplayData;

Defined in: model/ConstraintData.ts:77

---

pathSlot

pathSlot: SlotData;

Defined in: model/ConstraintData.ts:76

---

position

position: number;

Defined in: model/ConstraintData.ts:84

---

positionMode

positionMode: PositionMode;

Defined in: model/ConstraintData.ts:80

---

root

root: BoneData;

Defined in: model/ConstraintData.ts:36

Inherited from

ConstraintData.root

---

rotateMix

rotateMix: number;

Defined in: model/ConstraintData.ts:87

---

rotateMode

rotateMode: RotateMode;

Defined in: model/ConstraintData.ts:82

---

rotateOffset

rotateOffset: number;

Defined in: model/ConstraintData.ts:86

---

spacing

spacing: number;

Defined in: model/ConstraintData.ts:85

---

spacingMode

spacingMode: SpacingMode;

Defined in: model/ConstraintData.ts:81

---

target

target: BoneData;

Defined in: model/ConstraintData.ts:35

Inherited from

ConstraintData.target

---

translateMix

translateMix: number;

Defined in: model/ConstraintData.ts:88

---

type

type: ConstraintType;

Defined in: model/ConstraintData.ts:34

Inherited from

ConstraintData.type

Methods

AddBone()

AddBone(value: BoneData): void;

Defined in: model/ConstraintData.ts:108

Parameters

Parameter	Type
value	BoneData

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

ConstraintData.returnToPool

---

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

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

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

ConstraintData.setMaxCount

---

toString()

static toString(): string;

Defined in: model/ConstraintData.ts:72

Returns

string

Overrides

ConstraintData.toString