Skip to content

API / SingleValueTimelineState

Class: abstract SingleValueTimelineState

Defined in: animation/BaseTimelineState.ts:368

Internal

Extends

Extended by

Constructors

Constructor

ts
new SingleValueTimelineState(): SingleValueTimelineState;

Returns

SingleValueTimelineState

Inherited from

TweenTimelineState.constructor

Properties

currentPlayTimes

ts
currentPlayTimes: number;

Defined in: animation/BaseTimelineState.ts:38

Inherited from

TweenTimelineState.currentPlayTimes


currentTime

ts
currentTime: number;

Defined in: animation/BaseTimelineState.ts:39

Inherited from

TweenTimelineState.currentTime


dirty

ts
dirty: boolean;

Defined in: animation/BaseTimelineState.ts:33

Inherited from

TweenTimelineState.dirty


hashCode

ts
readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

TweenTimelineState.hashCode


playState

ts
playState: number;

Defined in: animation/BaseTimelineState.ts:37

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

Inherited from

TweenTimelineState.playState


target

ts
target: BaseObject;

Defined in: animation/BaseTimelineState.ts:40

Inherited from

TweenTimelineState.target

Methods

blend()

ts
blend(_isDirty: boolean): void;

Defined in: animation/BaseTimelineState.ts:231

Parameters

ParameterType
_isDirtyboolean

Returns

void

Inherited from

TweenTimelineState.blend


fadeOut()

ts
fadeOut(): void;

Defined in: animation/BaseTimelineState.ts:198

Returns

void

Inherited from

TweenTimelineState.fadeOut


init()

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

Defined in: animation/BaseTimelineState.ts:168

Parameters

ParameterType
armatureArmature
animationStateAnimationState
timelineDataTimelineData

Returns

void

Inherited from

TweenTimelineState.init


returnToPool()

ts
returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

TweenTimelineState.returnToPool


update()

ts
update(passedTime: number): void;

Defined in: animation/BaseTimelineState.ts:202

Parameters

ParameterType
passedTimenumber

Returns

void

Inherited from

TweenTimelineState.update


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

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

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

TweenTimelineState.setMaxCount


toString()

ts
static toString(): string;

Defined in: core/BaseObject.ts:56

Returns

string

Inherited from

TweenTimelineState.toString

Released under the MIT License.