Skip to main content

Interface: MaterialMeta

Metadata for a material in the rendering system. Contains essential information needed to load, reference, and apply materials to 3D models in the configurator.

Extends

Indexable

[key: string]: unknown

Properties

anisotrophyParameters?

optional anisotrophyParameters: Partial<MaterialAnisotropy>

Settings for direction-dependent reflections like brushed metal.

Inherited from

Partial.anisotrophyParameters


basicParameters?

optional basicParameters: Partial<MaterialBasic>

Core material properties controlling color, reflectivity, and transparency.

Inherited from

Partial.basicParameters


bumpParameters?

optional bumpParameters: Partial<MaterialBump>

Settings for surface relief and texture effects.

Inherited from

Partial.bumpParameters


clearCoatParameters?

optional clearCoatParameters: Partial<MaterialClearCoat>

Settings for transparent top-coat layer effects.

Inherited from

Partial.clearCoatParameters


colorGradingParameters?

optional colorGradingParameters: Partial<MaterialColorGrading>

Settings for cinematic color adjustment effects.

Inherited from

Partial.colorGradingParameters


emissiveParameters?

optional emissiveParameters: Partial<MaterialParameters>

Settings for self-illumination and glow effects.

Inherited from

Partial.emissiveParameters


history?

optional history: History

Revision tracking information.

Inherited from

Partial.history


loaded

loaded: boolean

Indicates if the material has been loaded into memory


materialId

materialId: string

Unique identifier for this material, used in material assignments

Overrides

Partial.materialId


materialName

materialName: string

Human-readable material name shown in the interface

Overrides

Partial.materialName


sheenParameters?

optional sheenParameters: Partial<MaterialSheen>

Settings for soft-gloss fabric-like highlights.

Inherited from

Partial.sheenParameters


status?

optional status: Status

Current activation status of this material.

Inherited from

Partial.status


subsurfaceParameters?

optional subsurfaceParameters: Partial<MaterialSubSurface>

Settings for translucent material effects where light penetrates the surface.

Inherited from

Partial.subsurfaceParameters


textureSize?

optional textureSize: string | number

Resolution of textures used for this material.

Inherited from

Partial.textureSize


textureSizes?

optional textureSizes: Partial<TextureSize>

Context-specific texture resolutions for different devices or scenarios.

Inherited from

Partial.textureSizes


thumbnail?

optional thumbnail: string

Path to the thumbnail image representing this material.

Inherited from

Partial.thumbnail


uid?

optional uid: string

Instance-specific identifier when the same material appears multiple times


uniqueId?

optional uniqueId: null | number

WebGL-specific material identifier once loaded into the rendering engine


uvScaleOffsetParameters?

optional uvScaleOffsetParameters: Partial<MaterialUvScaleOffset>

Controls for texture positioning, scaling, and orientation.

Inherited from

Partial.uvScaleOffsetParameters