Class Factory

Hierarchy

Factory

Index

Constructors

constructor

new Factory(config?: Config): Factory
Creates an instance of Factory.
Parameters
- Optional config: Config
Returns Factory
- Defined in src/Factory.ts:68

Properties

`Private` instance

instance: null | Init

Returns an instance of an Init

Author

Matej Hakoš

objectsLoaded

objectsLoaded: boolean = false

Returns if objects are already loaded to the scene

Author

Matej Hakoš

`Private` uuid

uuid: string

UUID of instance.

Author

Matej Hakoš

`Static` instanceCounter

instanceCounter: number = 0

Number of instances currently live.

Author

Matej Hakoš

Static

Methods

addAdnimation

addAdnimation(animationName: string, animtaion: AnimationDef): void
Adds an animation to AnimationStorage.
Parameters
- animationName: string
- animtaion: AnimationDef
Returns void
- Defined in src/Factory.ts:250

aliasAnimation

aliasAnimation(animationName: string, aliasName: string): void
Sets an alias for the animation.
Parameters
- animationName: string
- aliasName: string
Returns void
- Defined in src/Factory.ts:271

destroy

destroy(): void
Destroys this instance.

Returns void
- Defined in src/Factory.ts:117

`Private` generateUUID

generateUUID(): string
Private
Generated UUID for this instance.

Returns

Returns string
- Defined in src/Factory.ts:84

getAnimation

getAnimation(animationName: string): undefined | AnimationDef
Returns animation from AnimationStorage.

Returns
Parameters
- animationName: string
Returns undefined | AnimationDef
- Defined in src/Factory.ts:229

getAnimations

getAnimations(): Animations
Returns all animations in AnimationStorage.

Returns

Returns Animations
- Defined in src/Factory.ts:239

getCamera

getCamera(): undefined | PerspectiveCamera
Returns current instance of camera.

Returns

Returns undefined | PerspectiveCamera
- Defined in src/Factory.ts:298

getItem

getItem(id: ObjectID): undefined | Promise<undefined | Object3D>
Returns item based on its id.

Returns
Parameters
- id: ObjectID
Returns undefined | Promise<undefined | Object3D>
- Defined in src/Factory.ts:130

getObjects

getObjects(): undefined | Promise<Objects3D>
Returns all the obejcts loaded into scene.

Returns

Returns undefined | Promise<Objects3D>
- Defined in src/Factory.ts:165

group

group(event: string, callback: CallbackFunction): void
Adds a callback to all loaded objects.
Parameters
- event: string
- callback: CallbackFunction
Returns void
- Defined in src/Factory.ts:212

loadJSON

loadJSON(json: JSON): Factory
Loads input JSON file.

Returns
Parameters
- json: JSON
Returns Factory
- Defined in src/Factory.ts:106

moveToStep

moveToStep(stepNumber: number): void
Manually moves stepper to the specified step.
Parameters
- stepNumber: number
Returns void
- Defined in src/Factory.ts:155

on

on(selector: ObjectID, event: string, callback: CallbackFunction): void
Adds a callback to selector object.
Parameters
- selector: ObjectID
- event: string
- callback: CallbackFunction
Returns void
- Defined in src/Factory.ts:193

pauseRendering

pauseRendering(): void
Pauses rendering of the Instance.

Returns void
- Defined in src/Factory.ts:280

removeAnimation

removeAnimation(animationName: string): void
Removes an animation from AnimationStorage.
Parameters
- animationName: string
Returns void
- Defined in src/Factory.ts:260

resumeRendering

resumeRendering(): void
Resumes rendering of the Instance.

Returns void
- Defined in src/Factory.ts:288

selectItem

selectItem(id: ObjectID): void
Selects item in scene. (Same as double click on the item).
Parameters
- id: ObjectID
Returns void
- Defined in src/Factory.ts:140

setScaling

setScaling(scaling: number): void
Sets scaling for ALL objects in the scene.
Parameters
- scaling: number
Returns void
- Defined in src/Factory.ts:177

setView

setView(view?: CameraView): void
Sets camera to predefined view.
Parameters
- Optional view: CameraView
Returns void
- Defined in src/Factory.ts:321

updateCamera

updateCamera(callback: CameraCallback): void
Updates camera with function.
Parameters
- callback: CameraCallback
Returns void
- Defined in src/Factory.ts:307

Generated using TypeDoc