Class OperationCounter

Provides a way to track the progress of running operations.

Hierarchy (view full)

EventDispatcher<OperationCounterEvents>
- OperationCounter

Implements

Progress

Index

Constructors

constructor

new OperationCounter(): OperationCounter
Returns OperationCounter
Overrides EventDispatcher.constructor
- Defined in core/OperationCounter.ts:23

Accessors

completed

get completed(): number
Gets the number of completed operations.

Returns number
- Defined in core/OperationCounter.ts:41

loading

get loading(): boolean
Gets whether at least one operation is being executed.

Returns boolean
Implementation of Progress.loading
- Defined in core/OperationCounter.ts:48

operations

get operations(): number
Gets the number of pending operations.

Returns number
- Defined in core/OperationCounter.ts:34

progress

get progress(): number
Returns a number between 0 and 1 which represent the ratio between completed operations and total operations.

Returns number
Implementation of Progress.progress
- Defined in core/OperationCounter.ts:56

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof OperationCounterEvents
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<OperationCounterEvents[T], T, OperationCounter>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, OperationCounter>
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

decrement

decrement(): void
Decrements the number of pending operations.

Returns void
- Defined in core/OperationCounter.ts:67

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof OperationCounterEvents
Parameters
- event: BaseEvent<T> & OperationCounterEvents[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof OperationCounterEvents
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<OperationCounterEvents[T], T, OperationCounter>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, OperationCounter>
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

increment

increment(count?): void
Increment the number of pending operations.
Parameters
- count: number = 1
  How many increments to do. Default is 1.
Returns void
- Defined in core/OperationCounter.ts:98

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof OperationCounterEvents
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<OperationCounterEvents[T], T, OperationCounter>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, OperationCounter>
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

wrap

wrap<T>(promise): Promise<T>
Increments the counter before starting the promise, then decrements it safely when the promises resolves or fails.
Type Parameters
- T
Parameters
- promise: Promise<T>
Returns Promise<T>
- Defined in core/OperationCounter.ts:88

Class OperationCounter

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns OperationCounter

Accessors

completed

Returns number

loading

Returns boolean

operations

Returns number

progress

Returns number

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

decrement

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

increment

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

wrap

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page