Skip to content

API / TextureAtlasData

Class: abstract TextureAtlasData

Defined in: model/TextureAtlasData.ts:34

The texture atlas data.

Extends

Extended by

Constructors

Constructor

ts
new TextureAtlasData(): TextureAtlasData;

Returns

TextureAtlasData

Inherited from

BaseObject.constructor

Properties

hashCode

ts
readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

BaseObject.hashCode


imagePath

ts
imagePath: string;

Defined in: model/TextureAtlasData.ts:66

The image path of the texture atlas.


name

ts
name: string;

Defined in: model/TextureAtlasData.ts:58

The texture atlas name.

Methods

addTexture()

ts
addTexture(value: TextureData): void;

Defined in: model/TextureAtlasData.ts:117

Internal

Parameters

ParameterType
valueTextureData

Returns

void


createTexture()

ts
abstract createTexture(): TextureData;

Defined in: model/TextureAtlasData.ts:113

Internal

Returns

TextureData


returnToPool()

ts
returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

BaseObject.returnToPool


borrowObject()

ts
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

ParameterTypeDescription
objectConstructor() => TThe specify class.

Returns

T

Inherited from

BaseObject.borrowObject


clearPool()

ts
static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

ParameterTypeDefault valueDescription
objectConstructortypeof BaseObjectnullSpecify class. (Clear all cached instances if not set)

Returns

void

Inherited from

BaseObject.clearPool


setMaxCount()

ts
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

ParameterTypeDescription
objectConstructortypeof BaseObjectThe specify class. (Set all object pools max cache count if not set)
maxCountnumberMax count.

Returns

void

Inherited from

BaseObject.setMaxCount


toString()

ts
static toString(): string;

Defined in: core/BaseObject.ts:56

Returns

string

Inherited from

BaseObject.toString

Released under the MIT License.