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:34

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, TM>
Parameters
- template: IMaterialTemplate<TM, any>
- Optional oldMaterial: IMaterialParameters | Partial<TM>
Returns undefined | TM
- Defined in src/assetmanager/MaterialManager.ts:70

`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:111

`Protected` _getMapsForMaterial

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

`Protected` _materialUpdate

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

`Private` _refreshTextureRefs

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

applyMaterial

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

clearExtensions

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

clearMaterials

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

convertToIMaterial

convertToIMaterial(material, options?): undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
Parameters
- material: Material<Event, string> & {
  assetType?: "material";
  iMaterial?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>;
  }
- options: {
  materialTemplate?: string;
  useSourceMaterial?: boolean;
  } = {}
  - Optional materialTemplate?: string
  - Optional useSourceMaterial?: boolean
Returns undefined | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>
- Defined in src/assetmanager/MaterialManager.ts:240

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, TM>
Parameters
- nameOrType: string
- params: IMaterialParameters = {}
- register: boolean = true
Returns undefined | TM
- Defined in src/assetmanager/MaterialManager.ts:54

dispose

dispose(): void
Returns void
- Defined in src/assetmanager/MaterialManager.ts:206

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:292

registerMaterialExtension

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

registerMaterialTemplate

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

registerMaterials

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

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:181

unregisterMaterialExtension

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

unregisterMaterialTemplate

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

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, TM>

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>; }

options: { materialTemplate?: string; useSourceMaterial?: boolean; } = {}

Optional materialTemplate?: string

Optional useSourceMaterial?: boolean

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

create

Type Parameters

TM extends IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes, TM>

Parameters

nameOrType: string

params: IMaterialParameters = {}

register: boolean = true

Returns undefined | TM

dispose

Returns void

exportMaterial

Parameters

material: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>

Optional filename: string

minify: boolean = true

`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>;
}

options: {
materialTemplate?: string;
useSourceMaterial?: boolean;
} = {}

`Optional` materialTemplate?: string

`Optional` useSourceMaterial?: boolean

`Optional` filename: string

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