Class MaterialManager<T>

Material Manager Utility class to manage materials. Maintains a library of materials and material templates that can be used to manage or create new materials. Used in AssetManager to manage materials.

Type Parameters

T = ""

Hierarchy

EventDispatcher<BaseEvent, T>
- MaterialManager

Constructors

constructor

new MaterialManager<T>(): MaterialManager<T>
Type Parameters
- T = ""
Returns MaterialManager<T>
Overrides EventDispatcher<BaseEvent, T>.constructor
- Defined in src/assetmanager/MaterialManager.ts:38

Properties

`Protected` _materialExtensions

_materialExtensions: MaterialExtension[] = []

`Private` _materialMaps

_materialMaps: Map<string, Set<ITexture>> = ...

`Private` _materials

_materials: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[] = []

`Protected` _textureUpdate

_textureUpdate: ((this, e) => void) = ...

Type declaration

- (this, e): void
- Parameters
  - this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
  - e: ITextureEvent<"update">
  Returns void

`Readonly` templates

templates: IMaterialTemplate<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>, any>[] = ...

Methods

`Protected` _create

_create<TM>(template, oldMaterial?): undefined | TM
Type Parameters
- TM extends IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Parameters
- template: IMaterialTemplate<TM, any>
- Optional oldMaterial: IMaterialParameters | Partial<TM>
Returns undefined | TM
- Defined in src/assetmanager/MaterialManager.ts:74

`Protected` _disposeMaterial

_disposeMaterial(e): void
Parameters
- e: {
  target?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>;
  }
  - Optional target?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns void
- Defined in src/assetmanager/MaterialManager.ts:115

`Protected` _getMapsForMaterial

_getMapsForMaterial(material): Set<ITexture>
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns Set<ITexture>
- Defined in src/assetmanager/MaterialManager.ts:99

`Protected` _materialUpdate

_materialUpdate(e): void
Parameters
- e: IMaterialEvent<"materialUpdate">
Returns void
- Defined in src/assetmanager/MaterialManager.ts:128

`Private` _refreshTextureRefs

_refreshTextureRefs(mat): void
Parameters
- mat: any
Returns void
- Defined in src/assetmanager/MaterialManager.ts:139

applyMaterial

applyMaterial(material, nameOrUuid): boolean
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
- nameOrUuid: string
Returns boolean
- Defined in src/assetmanager/MaterialManager.ts:321

clearExtensions

clearExtensions(): void
Returns void
- Defined in src/assetmanager/MaterialManager.ts:308

clearMaterials

clearMaterials(): void
Returns void
- Defined in src/assetmanager/MaterialManager.ts:191

convertToIMaterial

convertToIMaterial(material, __namedParameters?): undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Creates a new material if a compatible template is found or apply minimal upgrades and returns the original material. Also checks from the registered materials, if one with the same uuid is found, it is returned instead with the new parameters. Also caches the response. Returns the same material if its already upgraded.
Parameters
- material: Material<Event, string> & {
  assetType?: "material";
  iMaterial?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>;
  }
  the material to upgrade/check
- __namedParameters: {
      createFromTemplate?: boolean;
      materialTemplate?: string;
      useSourceMaterial?: boolean;
  } = {}
  - Optional createFromTemplate?: boolean
  - Optional materialTemplate?: string
  - Optional useSourceMaterial?: boolean
Returns undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
- Defined in src/assetmanager/MaterialManager.ts:259

create

create<TM>(nameOrType, params?, register?): undefined | TM
Create a material from the template name or material type
Type Parameters
- TM extends IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Parameters
- nameOrType: string
- params: IMaterialParameters = {}
- register: boolean = true
Returns undefined | TM
- Defined in src/assetmanager/MaterialManager.ts:58

dispose

dispose(disposeRuntimeMaterials?): void
Parameters
- disposeRuntimeMaterials: boolean = true
Returns void
- Defined in src/assetmanager/MaterialManager.ts:210

exportMaterial

exportMaterial(material, filename?, minify?, download?): File
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
- Optional filename: string
- minify: boolean = true
- download: boolean = false
Returns File
- Defined in src/assetmanager/MaterialManager.ts:312

registerMaterialExtension

registerMaterialExtension(extension): void
Parameters
- extension: MaterialExtension
Returns void
- Defined in src/assetmanager/MaterialManager.ts:297

registerMaterialTemplate

registerMaterialTemplate(template): void
Parameters
- template: IMaterialTemplate<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>, any>
Returns void
- Defined in src/assetmanager/MaterialManager.ts:195

registerMaterials

registerMaterials(materials): void
Parameters
- materials: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]
Returns void
- Defined in src/assetmanager/MaterialManager.ts:177

unregisterMaterial

unregisterMaterial(material): void
This is done automatically on material dispose.
Parameters
- material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Returns void
- Defined in src/assetmanager/MaterialManager.ts:185

unregisterMaterialExtension

unregisterMaterialExtension(extension): void
Parameters
- extension: MaterialExtension
Returns void
- Defined in src/assetmanager/MaterialManager.ts:302

unregisterMaterialTemplate

unregisterMaterialTemplate(template): void
Parameters
- template: IMaterialTemplate<IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>, any>
Returns void
- Defined in src/assetmanager/MaterialManager.ts:205

Class MaterialManager<T>

Type Parameters

T = ""

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T = ""

Returns MaterialManager<T>

Properties

Protected _materialExtensions

Private _materialMaps

Private _materials

Protected _textureUpdate

Type declaration

Parameters

this: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

e: ITextureEvent<"update">

Returns void

Readonly templates

Methods

Protected _create

Type Parameters

TM extends IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Parameters

template: IMaterialTemplate<TM, any>

Optional oldMaterial: IMaterialParameters | Partial<TM>

Returns undefined | TM

Protected _disposeMaterial

Parameters

e: { target?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>; }

Optional target?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Returns void

Protected _getMapsForMaterial

Parameters

material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Returns Set<ITexture>

Protected _materialUpdate

Parameters

e: IMaterialEvent<"materialUpdate">

Returns void

Private _refreshTextureRefs

Parameters

mat: any

Returns void

applyMaterial

Parameters

material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

nameOrUuid: string

Returns boolean

clearExtensions

Returns void

clearMaterials

Returns void

convertToIMaterial

Parameters

material: Material<Event, string> & { assetType?: "material"; iMaterial?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>; }

__namedParameters: { createFromTemplate?: boolean; materialTemplate?: string; useSourceMaterial?: boolean; } = {}

Optional createFromTemplate?: boolean

Optional materialTemplate?: string

Optional useSourceMaterial?: boolean

Returns undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

create

Type Parameters

TM extends IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Parameters

nameOrType: string

params: IMaterialParameters = {}

register: boolean = true

Returns undefined | TM

dispose

Parameters

disposeRuntimeMaterials: boolean = true

Returns void

exportMaterial

Parameters

`Protected` _materialExtensions

`Private` _materialMaps

`Private` _materials

`Protected` _textureUpdate

`Readonly` templates

`Protected` _create

`Optional` oldMaterial: IMaterialParameters | Partial<TM>

`Protected` _disposeMaterial

e: {
target?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>;
}

`Optional` target?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

`Protected` _getMapsForMaterial

`Protected` _materialUpdate

`Private` _refreshTextureRefs

material: Material<Event, string> & {
assetType?: "material";
iMaterial?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>;
}

__namedParameters: {
createFromTemplate?: boolean;
materialTemplate?: string;
useSourceMaterial?: boolean;
} = {}

`Optional` createFromTemplate?: boolean

`Optional` materialTemplate?: string

`Optional` useSourceMaterial?: boolean

`Optional` filename: string

`Optional` params: Material<Event, string> | IMaterialParameters