Class: MaterialManager

Core-API.MaterialManager

Hierarchy

• AMaterialManager<"">

  ↳ MaterialManager

Constructors

constructor

• new MaterialManager()

Inherited from

AMaterialManager.constructor

Methods

findOrCreate

▸ findOrCreate(info, params?): undefined | IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
info	string
params?	AnyOptions

Returns

undefined | IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager.findOrCreate

---

generateFromTemplate

▸ generateFromTemplate(name, params?): undefined | IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
name	string
params?	AnyOptions

Returns

undefined | IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager.generateFromTemplate

---

generateFromTemplateType

▸ generateFromTemplateType(type, params?): undefined | IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
type	string
params?	AnyOptions

Returns

undefined | IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager.generateFromTemplateType

---

findTemplate

▸ findTemplate(name): undefined | IMaterialTemplate

Parameters

Name	Type
name	string

Returns

undefined | IMaterialTemplate

Inherited from

AMaterialManager.findTemplate

---

registerMaterial

▸ registerMaterial(material): void

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>

Returns

void

Inherited from

AMaterialManager.registerMaterial

---

registerMaterialObject

▸ registerMaterialObject(material): IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
material	any

Returns

IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager.registerMaterialObject

---

unregisterMaterial

▸ unregisterMaterial(material): void

This is done automatically on material dispose.

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>

Returns

void

Inherited from

AMaterialManager.unregisterMaterial

---

registerMaterialTemplate

▸ registerMaterialTemplate(template): void

Parameters

Name	Type
template	IMaterialTemplate

Returns

void

Inherited from

AMaterialManager.registerMaterialTemplate

---

unregisterMaterialTemplate

▸ unregisterMaterialTemplate(template): void

Parameters

Name	Type
template	IMaterialTemplate

Returns

void

Inherited from

AMaterialManager.unregisterMaterialTemplate

---

dispose

▸ dispose(disposeRuntimeMaterials?): void

Parameters

Name	Type	Default value
disposeRuntimeMaterials	boolean	true

Returns

void

Inherited from

AMaterialManager.dispose

---

findMaterial

▸ findMaterial(uuid): undefined | IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
uuid	string

Returns

undefined | IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager.findMaterial

---

findMaterialsByName

▸ findMaterialsByName(name, regex?): IMaterial<any, IMaterialEventMap>[]

Parameters

Name	Type	Default value
name	string | RegExp	undefined
regex	boolean	false

Returns

IMaterial<any, IMaterialEventMap>[]

Inherited from

AMaterialManager.findMaterialsByName

---

getMaterialsOfType

▸ getMaterialsOfType<TM>(typeSlug): TM[]

Type parameters

Name	Type
TM	extends IMaterial<any, IMaterialEventMap, TM> = IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
typeSlug	undefined | string

Returns

TM[]

Inherited from

AMaterialManager.getMaterialsOfType

---

getAllMaterials

▸ getAllMaterials(): IMaterial<any, IMaterialEventMap>[]

Returns

IMaterial<any, IMaterialEventMap>[]

Inherited from

AMaterialManager.getAllMaterials

---

processModel

▸ processModel(object, options): IModel<any, IObject3DEventMap>

Parameters

Name	Type
object	IModel<any, IObject3DEventMap>
options	AnyOptions

Returns

IModel<any, IObject3DEventMap>

Inherited from

AMaterialManager.processModel

---

processMaterial

▸ processMaterial(material, options): IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>
options	AnyOptions & { useSourceMaterial?: boolean ; materialTemplate?: string ; register?: boolean }

Returns

IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager.processMaterial

---

registerMaterialExtension

▸ registerMaterialExtension(extension): void

Parameters

Name	Type
extension	MaterialExtension

Returns

void

Inherited from

AMaterialManager.registerMaterialExtension

---

unregisterMaterialExtension

▸ unregisterMaterialExtension(extension): void

Parameters

Name	Type
extension	MaterialExtension

Returns

void

Inherited from

AMaterialManager.unregisterMaterialExtension

---

exportMaterial

▸ exportMaterial(material, filename?, minify?, download?): File

Parameters

Name	Type	Default value
material	IMaterial<any, IMaterialEventMap>	undefined
filename?	string	undefined
minify	boolean	true
download	boolean	false

Returns

File

Inherited from

AMaterialManager.exportMaterial

---

applyMaterial

▸ applyMaterial(material, nameRegexOrUuid, regex?): boolean

Parameters

Name	Type	Default value
material	IMaterial<any, IMaterialEventMap>	undefined
nameRegexOrUuid	string	undefined
regex	boolean	true

Returns

boolean

Inherited from

AMaterialManager.applyMaterial

---

copyMaterialProps

▸ copyMaterialProps(c, material): boolean

copyProps from material to c

Parameters

Name	Type
c	IMaterial<any, IMaterialEventMap>
material	IMaterial<any, IMaterialEventMap>

Returns

boolean

Inherited from

AMaterialManager.copyMaterialProps

---

_refreshTextureRefs

▸ Protected _refreshTextureRefs(materials?): void

Parameters

Name	Type
materials?	IMaterial<any, IMaterialEventMap>[]

Returns

void

Inherited from

AMaterialManager._refreshTextureRefs

---

_getMapsForMaterial

▸ Protected _getMapsForMaterial(material): Set<ITexture<any>>

Parameters

Name	Type
material	IMaterial<any, IMaterialEventMap>

Returns

Set<ITexture<any>>

Inherited from

AMaterialManager._getMapsForMaterial

---

_disposeMaterial

▸ Protected _disposeMaterial(e): void

Parameters

Name	Type
e	Object
e.target?	IMaterial<any, IMaterialEventMap>

Returns

void

Inherited from

AMaterialManager._disposeMaterial

---

_processMaterial

▸ Protected _processMaterial(material, options): undefined | IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
material	any
options	AnyOptions & { useSourceMaterial?: boolean ; materialTemplate?: string }

Returns

undefined | IMaterial<any, IMaterialEventMap>

Inherited from

AMaterialManager._processMaterial

---

_generateFromTemplate

▸ Protected _generateFromTemplate(template, oldMaterial?): undefined | IMaterial<any, IMaterialEventMap>

Parameters

Name	Type
template	IMaterialTemplate
oldMaterial?	AnyOptions

Returns

undefined | IMaterial<any, IMaterialEventMap>

Overrides

AMaterialManager._generateFromTemplate

---

_processModel

▸ Protected _processModel(object, options): IModel<any, IObject3DEventMap>

Parameters

Name	Type
object	IModel<any, IObject3DEventMap>
options	{ recursive?: boolean } & AnyOptions

Returns

IModel<any, IObject3DEventMap>

Overrides

AMaterialManager._processModel

Properties

_materialExtensions

• Protected _materialExtensions: MaterialExtension[] = []

Inherited from

AMaterialManager._materialExtensions