Class MaterialEngine

Index

Constructors

Accessors

Methods

createMaterialData createMaterialDataFromDefinition loadContent loadMap loadMapFromDefinition loadMapWithProperties loadMaterialDefinitionV1 loadMaterialDefinitionV2 loadMaterialDefinitionV3 loadMaterialV3 loadPresetMaterial loadPresetMaterialDefinition loadTexture

Constructors

constructor

new MaterialEngine(): MaterialEngine
Returns MaterialEngine

Accessors

`Static`instance

get instance(): MaterialEngine
Returns MaterialEngine

Methods

createMaterialData

createMaterialData(
materialProperties: IMaterialAbstractDataProperties,
): IMaterialAbstractData
Create a material data based on the material properties
Parameters
- materialProperties: IMaterialAbstractDataProperties
Returns IMaterialAbstractData

createMaterialDataFromDefinition

createMaterialDataFromDefinition(
definition: IMaterialAbstractDataPropertiesDefinition,
): Promise<IMaterialAbstractData>
Parameters
- definition: IMaterialAbstractDataPropertiesDefinition
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<MapData | undefined>
Parameters
- url: string
- Optionalid: string
Returns Promise<MapData | undefined>

loadMapFromDefinition

loadMapFromDefinition(
definition?: IMapDataPropertiesDefinition,
): Promise<MapData | undefined>
Load a map from a definition.
Parameters
- Optionaldefinition: IMapDataPropertiesDefinition
Returns Promise<MapData | undefined>

loadMapWithProperties

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

loadMaterialDefinitionV1

loadMaterialDefinitionV1(
data: IMaterialContentDataV1,
presetData?: IMaterialContentDataV3,
): IMaterialContentDataV3
Parameters
- data: IMaterialContentDataV1
- OptionalpresetData: IMaterialContentDataV3
Returns IMaterialContentDataV3

loadMaterialDefinitionV2

loadMaterialDefinitionV2(
data: IMaterialContentDataV2,
presetData?: IMaterialContentDataV3,
): IMaterialContentDataV3
Parameters
- data: IMaterialContentDataV2
- OptionalpresetData: IMaterialContentDataV3
Returns IMaterialContentDataV3

loadMaterialDefinitionV3

loadMaterialDefinitionV3(
data: IMaterialContentDataV3,
presetData?: IMaterialContentDataV3,
): IMaterialContentDataV3
Parameters
- data: IMaterialContentDataV3
- OptionalpresetData: 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

loadTexture

loadTexture(
    url: string,
): Promise<
    HttpResponse<
        { blob: Blob; buffer: ArrayBuffer; image?: HTMLImageElement },
    >,
>
Parameters
- url: string
Returns Promise<
    HttpResponse<
        { blob: Blob; buffer: ArrayBuffer; image?: HTMLImageElement },
    >,
>