Class ThreeBCF

Manager for converting three.js data to BCF data.

The topics should be created and stored in three.js space first. This class helps with the conversion to a BCF file format

Hierarchy

EventDispatcher
- ThreeBCF

Index

Constructors

Properties

Methods

addEventListener createBCF dispatchEvent hasEventListener removeEventListener testWorker

Constructors

constructor

new ThreeBCF(__namedParameters): ThreeBCF
Parameters
- __namedParameters: ThreeBCFParams
Returns ThreeBCF
Overrides THREE.EventDispatcher.constructor
- Defined in src/ThreeBCF.ts:41

Properties

version

version: string = VERSION

The version of the library.

`Private` worker

worker: Worker

The worker instance.

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, ThreeBCF>
  
  The function that gets called when the event is fired.
Returns void
Inherited from THREE.EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:46

createBCF

createBCF(params): void
From the current state, create a BCF file. This will be done in a Web Worker and the resulting file will be downloaded.
Parameters
- params: WorkerEventPostMessageData
  
  WorkerEventPostMessageData
Returns void
- Defined in src/ThreeBCF.ts:76

dispatchEvent

dispatchEvent(event): void
Fire an event type.
Parameters
- event: Event
  
  The event that gets fired.
Returns void
Inherited from THREE.EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:66

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, ThreeBCF>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from THREE.EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:53

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, T, ThreeBCF>
  
  The listener function that gets removed.
Returns void
Inherited from THREE.EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:60

`Private` testWorker

testWorker(): void
Test the worker thread.

Returns void
- Defined in src/ThreeBCF.ts:66

Generated using TypeDoc