Class MaterialEngine

Hierarchy

MaterialEngine

Index

Constructors

constructor

Accessors

instance

Methods

Constructors

constructor

new MaterialEngine(): MaterialEngine

Returns MaterialEngine

Accessors

Static instance

get instance(): MaterialEngine

Returns MaterialEngine

Methods

createMaterialData

createMaterialData(materialProperties: Partial<IMaterialAbstractDataPropertiesGeneric<IMapData>>): IMaterialAbstractData

Create a material data based on the material properties

Parameters
- materialProperties: Partial<IMaterialAbstractDataPropertiesGeneric<IMapData>>
Returns IMaterialAbstractData

createMaterialDataFromDefinition

createMaterialDataFromDefinition(definition: Partial<IMaterialAbstractDataPropertiesGeneric<IMapDataPropertiesDefinition>>): Promise<IMaterialAbstractData>

Parameters
- definition: Partial<IMaterialAbstractDataPropertiesGeneric<IMapDataPropertiesDefinition>>
Returns Promise<IMaterialAbstractData>

loadContent

loadContent(content: ShapeDiverResponseOutputContentBackend): Promise<ITreeNode>

Load the material content into a scene graph node.

Parameters
- content: ShapeDiverResponseOutputContentBackend
  
  the material content
Returns Promise<ITreeNode>
the scene graph node

loadMap

loadMap(url: string, id?: string): Promise<undefined | MapData>

Parameters
- url: string
- Optional id: string
Returns Promise<undefined | MapData>

loadMapFromDefinition

loadMapFromDefinition(definition?: IMapDataPropertiesDefinition): Promise<undefined | MapData>

Load a map from a definition.

Parameters
- Optional definition: IMapDataPropertiesDefinition
Returns Promise<undefined | MapData>

loadMapWithProperties

loadMapWithProperties(texture: ITexture): Promise<undefined | MapData>

Parameters
- texture: ITexture
Returns Promise<undefined | MapData>

loadMaterialDefinitionV1

loadMaterialDefinitionV1(data: IMaterialContentDataV1, presetData?: IMaterialContentDataV3): IMaterialContentDataV3

Parameters
- data: IMaterialContentDataV1
- Optional presetData: IMaterialContentDataV3
Returns IMaterialContentDataV3

loadMaterialDefinitionV2

loadMaterialDefinitionV2(data: IMaterialContentDataV2, presetData?: IMaterialContentDataV3): IMaterialContentDataV3

Parameters
- data: IMaterialContentDataV2
- Optional presetData: IMaterialContentDataV3
Returns IMaterialContentDataV3

loadMaterialDefinitionV3

loadMaterialDefinitionV3(data: IMaterialContentDataV3, presetData?: IMaterialContentDataV3): IMaterialContentDataV3

Parameters
- data: IMaterialContentDataV3
- Optional presetData: IMaterialContentDataV3
Returns IMaterialContentDataV3

loadMaterialV3

loadMaterialV3(data: IMaterialContentDataV3): Promise<MaterialStandardData>

Parameters
- data: IMaterialContentDataV3
Returns Promise<MaterialStandardData>

loadPresetMaterial

loadPresetMaterial(preset: number): Promise<MaterialStandardData>

Parameters
- preset: number
Returns Promise<MaterialStandardData>

loadPresetMaterialDefinition

loadPresetMaterialDefinition(preset: number): IMaterialContentDataV3

Parameters
- preset: number
Returns IMaterialContentDataV3