API / SurfaceTimelineState

Class: SurfaceTimelineState

Defined in: animation/TimelineState.ts:512

Internal

Extends

• MutilpleValueTimelineState

Constructors

Constructor

new SurfaceTimelineState(): SurfaceTimelineState;

Returns

SurfaceTimelineState

Inherited from

MutilpleValueTimelineState.constructor

Properties

currentPlayTimes

currentPlayTimes: number;

Defined in: animation/BaseTimelineState.ts:38

Inherited from

MutilpleValueTimelineState.currentPlayTimes

---

currentTime

currentTime: number;

Defined in: animation/BaseTimelineState.ts:39

Inherited from

MutilpleValueTimelineState.currentTime

---

dirty

dirty: boolean;

Defined in: animation/BaseTimelineState.ts:33

Inherited from

MutilpleValueTimelineState.dirty

---

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

MutilpleValueTimelineState.hashCode

---

playState

playState: number;

Defined in: animation/BaseTimelineState.ts:37

-1: start, 0: play, 1: complete;

Inherited from

MutilpleValueTimelineState.playState

---

target

target: BaseObject;

Defined in: animation/BaseTimelineState.ts:40

Inherited from

MutilpleValueTimelineState.target

Methods

blend()

blend(isDirty: boolean): void;

Defined in: animation/TimelineState.ts:550

Parameters

Parameter	Type
isDirty	boolean

Returns

void

Overrides

MutilpleValueTimelineState.blend

---

fadeOut()

fadeOut(): void;

Defined in: animation/BaseTimelineState.ts:198

Returns

void

Inherited from

MutilpleValueTimelineState.fadeOut

---

init()

init(
   armature: Armature, 
   animationState: AnimationState, 
   timelineData: TimelineData): void;

Defined in: animation/TimelineState.ts:529

Parameters

Parameter	Type
armature	Armature
animationState	AnimationState
timelineData	TimelineData

Returns

void

Overrides

MutilpleValueTimelineState.init

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

MutilpleValueTimelineState.returnToPool

---

update()

update(passedTime: number): void;

Defined in: animation/BaseTimelineState.ts:202

Parameters

Parameter	Type
passedTime	number

Returns

void

Inherited from

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

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

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

MutilpleValueTimelineState.setMaxCount

---

toString()

static toString(): string;

Defined in: animation/TimelineState.ts:513

Returns

string

Overrides

MutilpleValueTimelineState.toString