Class MaterialFactory

Builds every material used by batched mesh, edge and line containers — opaque, transparent and x-ray variants, plus their selected counterparts — reading defaults (colors, opacity, shading) from the viewer's settings.

Index

Constructors

constructor

Methods

getBatchedEdgesOpaqueMaterial getBatchedEdgesOpaqueMaterial_Selected getBatchedEdgesTransparentMaterial getBatchedEdgesTransparentMaterial_Selected getBatchedEdgesXRayMaterial getBatchedEdgesXRayMaterial_Selected getBatchedLineOpaqueMaterial getBatchedLineOpaqueMaterial_Selected getBatchedLineTransparentMaterial getBatchedLineTransparentMaterial_Selected getBatchedLineXRayMaterial getBatchedLineXRayMaterial_Selected getBatchedMeshOpaqueMaterial getBatchedMeshOpaqueMaterial_Selected getBatchedMeshTransparentMaterial getBatchedMeshTransparentMaterial_Selected getBatchedMeshXRayMaterial getBatchedMeshXRayMaterial_Selected

Constructors

constructor

new MaterialFactory(viewer: Viewer): MaterialFactory
Parameters
- viewer: Viewer
Returns MaterialFactory
- Defined in packages/viewer/src/scene/objects/MaterialFactory.ts:72

Methods

getBatchedMeshOpaqueMaterial_Selected

getBatchedMeshOpaqueMaterial_Selected(
    texture: MaterialPropertyTexture,
    parameters?: BatchedMeshStandardMaterialParameters,
): {
    layer: Base | SelectedObject;
    material: BatchedMeshStandardMaterial;
    type: MaterialType;
}
Parameters
- texture: MaterialPropertyTexture
- parameters: BatchedMeshStandardMaterialParameters = {}
Returns {
    layer: Base | SelectedObject;
    material: BatchedMeshStandardMaterial;
    type: MaterialType;
}
- Defined in packages/viewer/src/scene/objects/MaterialFactory.ts:104

getBatchedMeshTransparentMaterial

getBatchedMeshTransparentMaterial(
texture: MaterialPropertyTexture,
parameters?: BatchedMeshStandardMaterialParameters,
): MaterialConfig<BatchedMeshStandardMaterial>
Parameters
- texture: MaterialPropertyTexture
- parameters: BatchedMeshStandardMaterialParameters = {}
Returns MaterialConfig<BatchedMeshStandardMaterial>
- Defined in packages/viewer/src/scene/objects/MaterialFactory.ts:124

getBatchedMeshTransparentMaterial_Selected

getBatchedMeshTransparentMaterial_Selected(
texture: MaterialPropertyTexture,
parameters?: BatchedMeshStandardMaterialParameters,
): MaterialConfig<BatchedMeshStandardMaterial>
Parameters
- texture: MaterialPropertyTexture
- parameters: BatchedMeshStandardMaterialParameters = {}
Returns MaterialConfig<BatchedMeshStandardMaterial>
- Defined in packages/viewer/src/scene/objects/MaterialFactory.ts:149

getBatchedMeshXRayMaterial

getBatchedMeshXRayMaterial(
texture: MaterialPropertyTexture,
parameters?: BatchedMeshStandardMaterialParameters,
): MaterialConfig<BatchedMeshStandardMaterial>
Parameters
- texture: MaterialPropertyTexture
- parameters: BatchedMeshStandardMaterialParameters = {}
Returns MaterialConfig<BatchedMeshStandardMaterial>
- Defined in packages/viewer/src/scene/objects/MaterialFactory.ts:171

getBatchedMeshXRayMaterial_Selected

getBatchedMeshXRayMaterial_Selected(
texture: MaterialPropertyTexture,
parameters?: BatchedMeshStandardMaterialParameters,
): MaterialConfig<BatchedMeshStandardMaterial>
Parameters
- texture: MaterialPropertyTexture
- parameters: BatchedMeshStandardMaterialParameters = {}
Returns MaterialConfig<BatchedMeshStandardMaterial>
- Defined in packages/viewer/src/scene/objects/MaterialFactory.ts:198

Class MaterialFactory

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MaterialFactory

Methods

getBatchedEdgesOpaqueMaterial

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedEdgesOpaqueMaterial_Selected

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedEdgesTransparentMaterial

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedEdgesTransparentMaterial_Selected

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedEdgesXRayMaterial

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedEdgesXRayMaterial_Selected

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedLineOpaqueMaterial

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedLineOpaqueMaterial_Selected

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedLineTransparentMaterial

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedLineTransparentMaterial_Selected

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedLineXRayMaterial

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedLineXRayMaterial_Selected

Parameters

Returns MaterialConfig<BatchedLineDashedMaterial>

getBatchedMeshOpaqueMaterial

Parameters

Returns MaterialConfig<BatchedMeshStandardMaterial>

getBatchedMeshOpaqueMaterial_Selected

Parameters

Returns { layer: Base | SelectedObject; material: BatchedMeshStandardMaterial; type: MaterialType;}

getBatchedMeshTransparentMaterial

Parameters

Returns MaterialConfig<BatchedMeshStandardMaterial>

getBatchedMeshTransparentMaterial_Selected

Parameters

Returns MaterialConfig<BatchedMeshStandardMaterial>

getBatchedMeshXRayMaterial

Parameters

Returns MaterialConfig<BatchedMeshStandardMaterial>

getBatchedMeshXRayMaterial_Selected

Parameters

Returns MaterialConfig<BatchedMeshStandardMaterial>

Settings

On This Page

Returns {
layer: Base | SelectedObject;
material: BatchedMeshStandardMaterial;
type: MaterialType;
}