Bootstrap | g.frame

Hierarchy

ViewerModule
- Bootstrap

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Bootstrap(): Bootstrap

Overrides ViewerModule.constructor
- Defined in packages/g.frame.core/src/core/Bootstrap.ts:4
Returns Bootstrap

Properties

Protected events

events: Array<EventDescriptor<string>>

isViewer

isViewer: boolean = true

uiObject

uiObject: Object3D

Methods

addObject

addObject(object: any, disposeParams?: IDisposeParams, parentObject?: Object3D): any

Inherited from ViewerModule.addObject
- Defined in packages/g.frame.core/src/core/ViewerModule.ts:58
Function to add new mesh to uiObject, to automatize that disposing

Parameters
- object: any
- Optional disposeParams: IDisposeParams
  
  What need to be disposed in mesh, when viewer is disposing
- Default value parentObject: Object3D = this.uiObject
Returns any

object

dispose

dispose(): void

Inherited from ViewerModule.dispose
- Defined in packages/g.frame.core/src/core/ViewerModule.ts:140
Automatized dispose function, works with objects, that are added with addObject function

Returns void

disposeObject

disposeObject(object?: Object3D | ViewerModule, disposeParams?: any): void

Inherited from ViewerModule.disposeObject
- Defined in packages/g.frame.core/src/core/ViewerModule.ts:101
Function to dispose mesh and remove it from uiObject

Parameters
- Optional object: Object3D | ViewerModule
- Optional disposeParams: any
Returns void

fire

fire(eventName: string | Array<string>, data?: ParentEvent<string>): this

Inherited from EventDispatcher.fire
- Defined in packages/g.frame.core/src/core/EventDispatcher.ts:45
Parameters
- eventName: string | Array<string>
- Default value data: ParentEvent<string> = new ParentEvent<T>()
Returns this

getGlobalPosition

getGlobalPosition(): Vector3

Inherited from ViewerModule.getGlobalPosition
- Defined in packages/g.frame.core/src/core/ViewerModule.ts:42
Function to get world position of this ViewerModule

Returns Vector3

Global position

off

off(eventName?: string, callback?: Function): this

Inherited from EventDispatcher.off
- Defined in packages/g.frame.core/src/core/EventDispatcher.ts:36
Parameters
- Optional eventName: string
- Optional callback: Function
Returns this

on

on(eventName: string, callback1: Function, callback2?: Function): this

Inherited from EventDispatcher.on
- Defined in packages/g.frame.core/src/core/EventDispatcher.ts:18
Parameters
- eventName: string
- callback1: Function
- Optional callback2: Function
Returns this

onInit

onInit(modulesProcessor: ModulesProcessor): void

- Defined in packages/g.frame.core/src/core/Bootstrap.ts:9
Parameters
- modulesProcessor: ModulesProcessor
Returns void

once

once(eventName: string, callback1: Function, callback2?: Function): this

Inherited from EventDispatcher.once
- Defined in packages/g.frame.core/src/core/EventDispatcher.ts:25
Parameters
- eventName: string
- callback1: Function
- Optional callback2: Function
Returns this

removeObject

removeObject(object: any): void

Inherited from ViewerModule.removeObject
- Defined in packages/g.frame.core/src/core/ViewerModule.ts:85
Function to remove mesh from uiObject

Parameters
- object: any
Returns void

update

update(): void

Inherited from ViewerModule.update
- Defined in packages/g.frame.core/src/core/ViewerModule.ts:133
Update function to call in each frame

Returns void

Generated using TypeDoc