AbstractModule | g.frame

Hierarchy

EventDispatcher<string>
- AbstractModule

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AbstractModule(): AbstractModule

Inherited from EventDispatcher.constructor
- Defined in packages/g.frame.core/src/core/EventDispatcher.ts:12
Returns AbstractModule

Properties

__requiredModules

__requiredModules: Array<Constructor<AbstractModule>>

Protected events

events: Array<EventDescriptor<string>>

Protected instances

instances: Map<string, any>

Map of instances, that are owned by this module

Methods

Abstract afterInit

afterInit(agents?: ConstructorInstanceMap<any>, modules?: ConstructorInstanceMap<AbstractModule>): void

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:42
Function that is called after initialization. Use it only for internal stuff.

Parameters
- Optional agents: ConstructorInstanceMap<any>
- Optional modules: ConstructorInstanceMap<AbstractModule>
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

getInstance

getInstance(name: string): any

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:21
Function to get instance from current module

Parameters
- name: string
  
  Name of instance. Check the documentation of module
Returns any

getModuleContainer

getModuleContainer(): Object3D | void

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:45
Returns Object3D | void

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

Abstract onDestroy

onDestroy(): void

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:59
Function that is called before actual destruction. All resources should be disposed and removed.

Returns void

Abstract onInit

onInit(data: any): Promise<Array<any>>

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:37
Initialization of module. All instances have to be created in this function.

todo

Describe data argument in initialization function

Parameters
- data: any
  
  Data from g.frame core.
Returns Promise<Array<any>>

Promise of instances array

onPause

onPause(): void

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:64
Function that is called when application is paused (For example tab is changed)

Returns void

onResume

onResume(): void

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:69
Function that is called when application is resumed

Returns void

Abstract onUpdate

onUpdate(params: { currentTime: number; frame: any }): void

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:54
Update function for module. Use only this function for all updates.

todo

When typescript will have WebXR API declarations -- put frame: XRFrame

Parameters
- params: { currentTime: number; frame: any }
  
  Current frame information
  - currentTime: number
    
    Time in milliseconds from starts
  - frame: any
    
    Current XRFrame for WebXR
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

Abstract preInit

preInit(): Promise<AbstractModuleStatus>

- Defined in packages/g.frame.core/src/core/AbstractModule.ts:29
Function, that is called before actual initialization. Use it to check hardware, check compatibility, etc.

Returns Promise<AbstractModuleStatus>

Promise of Module status. For example if this module supported by user's hardware?

Generated using TypeDoc