Winter Cardinal UI - v0.442.0 / DAnimationBase

Class: DAnimationBase<TARGET>

Type parameters

Name	Type
TARGET	unknown

Hierarchy

• EventEmitter

  ↳ DAnimationBase

  ↳↳ DAnimationFadeIn

Implements

• DAnimation<TARGET>

Table of contents

Constructors

• constructor

Properties

• _duration
• _durationInverse
• _id
• _onEnd
• _onStart
• _onStop
• _onTime
• _onTimeBaseBound
• _reverse
• _startTime
• _target
• _timing

Accessors

• duration
• target

Methods

• addListener
• emit
• end
• eventNames
• isReverse
• isStarted
• listenerCount
• listeners
• off
• on
• onEnd
• onStart
• onStop
• onTime
• onTimeBase
• once
• removeAllListeners
• removeListener
• start
• stop
• toTime

Constructors

constructor

• new DAnimationBase<TARGET>(options?): DAnimationBase<TARGET>

Type parameters

Name	Type
TARGET	unknown

Parameters

Name	Type
options?	DAnimationOptions<TARGET, DAnimation<TARGET>>

Returns

DAnimationBase<TARGET>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:34

Properties

_duration

• Protected _duration: number

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:23

---

_durationInverse

• Protected _durationInverse: number

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:24

---

_id

• Protected _id: null | number

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:21

---

_onEnd

• Protected _onEnd: undefined | DAnimationOnEnd<TARGET>

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:29

---

_onStart

• Protected _onStart: undefined | DAnimationOnEnd<TARGET>

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:28

---

_onStop

• Protected _onStop: undefined | DAnimationOnStop<TARGET>

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:30

---

_onTime

• Protected _onTime: undefined | DAnimationOnTime<TARGET>

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:26

---

_onTimeBaseBound

• Protected _onTimeBaseBound: () => void

Type declaration

▸ (): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:27

---

_reverse

• Protected _reverse: boolean

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:25

---

_startTime

• Protected _startTime: number

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:22

---

_target

• Protected _target: null | TARGET

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:32

---

_timing

• Protected _timing: DAnimationTiming<TARGET>

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:31

Accessors

duration

• get duration(): number

An animation duration.

Returns

number

Implementation of

DAnimation.duration

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:72

• set duration(duration): void

An animation duration.

Parameters

Name	Type
duration	number

Returns

void

Implementation of

DAnimation.duration

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:76

---

target

• get target(): null | TARGET

An animation target.

Returns

null | TARGET

Implementation of

DAnimation.target

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:64

• set target(target): void

An animation target.

Parameters

Name	Type
target	null | TARGET

Returns

void

Implementation of

DAnimation.target

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:68

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Implementation of

DAnimation.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495

---

emit

▸ emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
...args	any[]	Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Implementation of

DAnimation.emit

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441

---

end

▸ end(): void

Moves an animation frame to the end.

Returns

void

Implementation of

DAnimation.end

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:175

---

eventNames

▸ eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Implementation of

DAnimation.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415

---

isReverse

▸ isReverse(): boolean

Returns true if an animation is in a reverse mode.

Returns

boolean

Implementation of

DAnimation.isReverse

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:132

---

isStarted

▸ isStarted(): boolean

Returns true if an animation is playing.

Returns

boolean

Implementation of

DAnimation.isStarted

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:128

---

listenerCount

▸ listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

number

Implementation of

DAnimation.listenerCount

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432

---

listeners

▸ listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.

Returns

Function[]

Implementation of

DAnimation.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424

---

off

▸ off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name	Type
event	string | symbol
fn?	Function
context?	any
once?	boolean

Returns

this

Implementation of

DAnimation.off

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489

---

on

▸ on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DAnimation.on

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452

---

onEnd

▸ onEnd(isReverse): void

Parameters

Name	Type
isReverse	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:112

---

onStart

▸ onStart(isReverse): void

Parameters

Name	Type
isReverse	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:96

---

onStop

▸ onStop(isReverse): void

Parameters

Name	Type
isReverse	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:120

---

onTime

▸ onTime(time, isReverse, elapsedTime): void

Parameters

Name	Type
time	number
isReverse	boolean
elapsedTime	number

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:104

---

onTimeBase

▸ onTimeBase(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:136

---

once

▸ once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn	Function	The listener function.
context?	any	The context to invoke the listener with.

Returns

this

this.

Implementation of

DAnimation.once

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463

---

removeAllListeners

▸ removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name	Type	Description
event?	string | symbol	The event name.

Returns

this

this.

Implementation of

DAnimation.removeAllListeners

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483

---

removeListener

▸ removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name	Type	Description
event	string | symbol	The event name.
fn?	Function	Only remove the listeners that match this function.
context?	any	Only remove the listeners that have this context.
once?	boolean	Only remove one-time listeners.

Returns

this

this.

Implementation of

DAnimation.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475

---

start

▸ start(reverse?): void

Starts an animation.

Parameters

Name	Type	Default value	Description
reverse	boolean	false	true to play in reverse.

Returns

void

Implementation of

DAnimation.start

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:81

---

stop

▸ stop(): void

Stops an animation as is.

Returns

void

Implementation of

DAnimation.stop

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:164

---

toTime

▸ toTime(elapsedTime): number

Parameters

Name	Type
elapsedTime	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-animation-base.ts:160

Edit this page.