OBJModelsLoader | g.frame

Hierarchy

Loader<Object3D>
- OBJModelsLoader

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OBJModelsLoader(): OBJModelsLoader

Overrides Loader.constructor
- Defined in packages/g.frame.common.loaders/src/default/OBJModelsLoader.ts:7
Returns OBJModelsLoader

Properties

__agentConstructor

__agentConstructor: Function

Protected library

library: Map<string, Object3D> = new Map<string, T>()

loaderType

loaderType: string = OBJ_MODEL

Protected resourcesRaw

resourcesRaw: Array<ResourceRaw> = []

Methods

addResources

addResources(newResource: Array<ResourceRaw> | ResourceRaw): boolean

Inherited from Loader.addResources
- Defined in packages/g.frame.common.loaders/src/Loader.ts:30
Parameters
- newResource: Array<ResourceRaw> | ResourceRaw
  
  ResourceRaw new items that will be added to library once .load() passes through
Returns boolean

boolean based on if the resource type is supported for the Loader, name and url exist. Defines if is it added to resourcesRaw Array

getResource

getResource<C>(name: string, _throwWarning?: boolean): C

Inherited from Loader.getResource
- Defined in packages/g.frame.common.loaders/src/Loader.ts:70
USE THIS FUNCTION TO GET READY RESOURCES

Type parameters
- C: Object3D
Parameters
- name: string
  
  string Resource name to get
- Default value _throwWarning: boolean = true
  
  boolean
Returns C

resource with the provided name, or undefined if none was found

load

load(): Promise<void>

Inherited from Loader.load
- Defined in packages/g.frame.common.loaders/src/Loader.ts:46
Returns Promise<void>

Promise that executes after all raw resources was loaded according to resourceToPromise

Protected resourceToPromise

resourceToPromise(url: string, name: string): Promise<Object3D>

Overrides Loader.resourceToPromise
- Defined in packages/g.frame.common.loaders/src/default/OBJModelsLoader.ts:13
Parameters
- url: string
- name: string
Returns Promise<Object3D>

Protected setResource

setResource(name: string, resource: Object3D): void

Inherited from Loader.setResource
- Defined in packages/g.frame.common.loaders/src/Loader.ts:85
Parameters
- name: string
  
  string Resource name to set
- resource: Object3D
  
  to set to library of loaded resources
Returns void

resource with the provided name, or undefined if none was found

Generated using TypeDoc