Skip to content

editor › Globals › ModuleLoader

Class: ModuleLoader

The ModuleLoader takes care of loading and initializing modules as well as binding them to the required editor core classes

Hierarchy

  • ModuleLoader

Index

Properties

Methods

Properties

Private initializedModules

• initializedModules: Map‹string, Module‹›› = new Map()

Defined in src/modularization/ModuleLoader.ts:15

Private moduleProviders

• moduleProviders: ModuleProvider[] = []

Defined in src/modularization/ModuleLoader.ts:12

Methods

Private _fetchModuleClass

▸ _fetchModuleClass(moduleName: string): object

Defined in src/modularization/ModuleLoader.ts:118

Parameters:

Name Type
moduleName string

Returns: object

The module Class. May return null if the module was not found.

Private _initializeModule

▸ _initializeModule(ModuleClass: object): Module

Defined in src/modularization/ModuleLoader.ts:107

Parameters:

Name Type
ModuleClass object

Returns: Module

assignEditor

▸ assignEditor(editor: Editor): void

Defined in src/modularization/ModuleLoader.ts:84

Parameters:

Name Type
editor Editor

Returns: void

assignPhysicsSimulationRunner

▸ assignPhysicsSimulationRunner(physicsSimulationRunner: any): void

Defined in src/modularization/ModuleLoader.ts:78

Parameters:

Name Type
physicsSimulationRunner any

Returns: void

getModuleInstance

▸ getModuleInstance(moduleName: string): Module

Defined in src/modularization/ModuleLoader.ts:29

Parameters:

Name Type Description
moduleName string module instance to retrieve

Returns: Module

the instance of the specified module

getModuleInstances

▸ getModuleInstances(): Map‹string, Module‹››

Defined in src/modularization/ModuleLoader.ts:36

Returns: Map‹string, Module‹››

a map containing the initialized modules (name -> module class instance)

initializeTools

▸ initializeTools(toolLibrary: ToolLibrary): void

Defined in src/modularization/ModuleLoader.ts:91

Parameters:

Name Type
toolLibrary ToolLibrary

Returns: void

load

▸ load(moduleNames: string[]): object

Defined in src/modularization/ModuleLoader.ts:47

Loads all modules specified by the supplied module config

Parameters:

Name Type Description
moduleNames string[] the names of the modules to load

Returns: object

Queries all moduleProviders to get the specified module class the error that was thrown while initializing the module.

registerModuleProvider

▸ registerModuleProvider(moduleProvider: ModuleProvider): void

Defined in src/modularization/ModuleLoader.ts:21

Registers a ModuleProvider that will be used to fetch modules

Parameters:

Name Type Description
moduleProvider ModuleProvider -

Returns: void