API / BaseObject

Class: abstract BaseObject

Defined in: core/BaseObject.ts:33

The BaseObject is the base class for all objects in the DragonBones framework. All BaseObject instances are cached to the object pool to reduce the performance consumption of frequent requests for memory or memory recovery.

Extended by

• Animation
• AnimationState
• BlendState
• TimelineState
• Armature
• Constraint
• TransformObject
• EventObject
• AnimationConfig
• AnimationData
• ArmatureData
• BoneData
• SlotData
• BoundingBoxData
• DragonBonesData
• SkinData
• TextureAtlasData
• UserData

Constructors

Constructor

new BaseObject(): BaseObject;

Returns

BaseObject

Properties

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Methods

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

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

---

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

---

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

---

toString()

static toString(): string;

Defined in: core/BaseObject.ts:56

Returns

string