ThreePipe
    Preparing search index...

    Class MaterialManager<TEventMap>

    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

    • TEventMap extends object = object

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    _materialExtensions unregisterExtensionsOnRemove

    Methods

    _create _disposeMaterial _registerMaterial applyMaterial clearExtensions clearMaterials convertToIMaterial copyMaterialProps create dispose exportMaterial findMaterial findMaterialsByName findOrCreate findTemplate getAllMaterials getMaterialsOfType registerMaterial registerMaterialExtension registerMaterials registerMaterialTemplate unregisterMaterial unregisterMaterialExtension unregisterMaterialTemplate

    Constructors

    Properties

    Protected_materialExtensions

    _materialExtensions: MaterialExtension[] = []
    unregisterExtensionsOnRemove: boolean = false

    Methods

    Protected_create

    • _create<TM extends IMaterial<IMaterialEventMap>>(
          template: {
              InterpolateProperties?: string[];
              MapProperties?: string[];
              MaterialProperties?: Record<string, any>;
              TYPE: string;
              TypeAlias?: string[];
              TypeSlug: string;
              new (...args: any[]): IMaterial;
          },
          oldMaterial?: IMaterialParameters | Partial<TM>,
      ): undefined | TM

      Type Parameters

      Parameters

      • template: {
            InterpolateProperties?: string[];
            MapProperties?: string[];
            MaterialProperties?: Record<string, any>;
            TYPE: string;
            TypeAlias?: string[];
            TypeSlug: string;
            new (...args: any[]): IMaterial;
        }
      • OptionaloldMaterial: IMaterialParameters | Partial<TM>

      Returns undefined | TM

    Protected_disposeMaterial

    Protected_registerMaterial

    • 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<MaterialEventMap> & {
            assetType?: "material";
            iMaterial?: IMaterial<IMaterialEventMap>;
        }

        the material to upgrade/check

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

      Returns undefined | IMaterial<IMaterialEventMap>

    • Parameters

      • material: IMaterial
      • Optionalfilename: string
      • minify: boolean = true
      • download: boolean = false

      Returns File

    • Parameters

      • type: string

      Returns
          | undefined
          | {
              InterpolateProperties?: string[];
              MapProperties?: string[];
              MaterialProperties?: Record<string, any>;
              TYPE: string;
              TypeAlias?: string[];
              TypeSlug: string;
              new (...args: any[]): IMaterial;
          }

      use ThreeSerialization.SerializableMaterials directly

    • Parameters

      • template: {
            InterpolateProperties?: string[];
            MapProperties?: string[];
            MaterialProperties?: Record<string, any>;
            TYPE: string;
            TypeAlias?: string[];
            TypeSlug: string;
            new (...args: any[]): IMaterial;
        }

      Returns void

      use ThreeSerialization.SerializableMaterials directly

    • Parameters

      • template: {
            InterpolateProperties?: string[];
            MapProperties?: string[];
            MaterialProperties?: Record<string, any>;
            TYPE: string;
            TypeAlias?: string[];
            TypeSlug: string;
            new (...args: any[]): IMaterial;
        }

      Returns void

      use ThreeSerialization.SerializableMaterials directly

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods