Class ViewerMaterials

Defines the materials to be used by the vim loader and allows for material injection.

Hierarchy

ViewerMaterials

Index

Constructors

constructor

new ViewerMaterials(opaque?: StandardMaterial, transparent?: StandardMaterial, wireframe?: LineBasicMaterial, isolation?: Material, mask?: ShaderMaterial, outline?: OutlineMaterial, merge?: MergeMaterial, grid?: ShaderMaterial): ViewerMaterials
Parameters
- Optional opaque: StandardMaterial
- Optional transparent: StandardMaterial
- Optional wireframe: LineBasicMaterial
- Optional isolation: Material
- Optional mask: ShaderMaterial
- Optional outline: OutlineMaterial
- Optional merge: MergeMaterial
- Optional grid: ShaderMaterial
Returns ViewerMaterials
- Defined in src/vim-loader/materials/viewerMaterials.ts:69

Properties

isolation

isolation: Material

Material used to show traces of hidden objects

mask

mask: ShaderMaterial

Material used to filter out what is not selected for selection outline effect.

merge

merge: MergeMaterial

Material used to merge outline effect with scene render.

opaque

opaque: StandardMaterial

Material used for opaque model geometry

outline

outline: OutlineMaterial

Material used for selection outline effect.

transparent

transparent: StandardMaterial

Material used for transparent model geometry

wireframe

wireframe: LineBasicMaterial

Material used when creating wireframe geometry of the model

`Static` instance

instance: ViewerMaterials

Accessors

clippingPlanes

get clippingPlanes(): Plane[]
The clipping planes applied to all relevent materials

Returns Plane[]
- Defined in src/vim-loader/materials/viewerMaterials.ts:205
set clippingPlanes(value: Plane[]): void
Parameters
- value: Plane[]
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:209

focusColor

get focusColor(): Color
Determines the color of the highlight effect on mouse hover.

Returns Color
- Defined in src/vim-loader/materials/viewerMaterials.ts:163
set focusColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:167

focusIntensity

get focusIntensity(): number
Determines the color intensity of the highlight effect on mouse hover.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:148
set focusIntensity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:152

isolationColor

get isolationColor(): Color
Determines the color of the isolation material.

Returns Color
- Defined in src/vim-loader/materials/viewerMaterials.ts:133
set isolationColor(color: Color): void
Parameters
- color: Color
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:138

isolationOpacity

get isolationOpacity(): number
Determines the opacity of the isolation material.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:119
set isolationOpacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:123

onUpdate

get onUpdate(): ISignal
A signal dispatched whenever a material is modified.

Returns ISignal
- Defined in src/vim-loader/materials/viewerMaterials.ts:112

outlineBlur

get outlineBlur(): number
Size of the blur convolution on the selection outline effect.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:281
set outlineBlur(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:285

outlineColor

get outlineColor(): Color
Color of the selection outline effect.

Returns Color
- Defined in src/vim-loader/materials/viewerMaterials.ts:268
set outlineColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:272

outlineFalloff

get outlineFalloff(): number
Gradient of the the selection outline effect.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:294
set outlineFalloff(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:298

outlineIntensity

get outlineIntensity(): number
Intensity of the the selection outline effect.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:307
set outlineIntensity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:311

sectionStrokeColor

get sectionStrokeColor(): Color
Color of the stroke effect where the section box intersects the model.

Returns Color
- Defined in src/vim-loader/materials/viewerMaterials.ts:253
set sectionStrokeColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:257

sectionStrokeFallof

get sectionStrokeFallof(): number
Gradient of the stroke effect where the section box intersects the model.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:238
set sectionStrokeFallof(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:242

sectionStrokeWitdh

get sectionStrokeWitdh(): number
The width of the stroke effect where the section box intersects the model.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:223
set sectionStrokeWitdh(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:227

wireframeColor

get wireframeColor(): Color
Determines the color of wireframe meshes.

Returns Color
- Defined in src/vim-loader/materials/viewerMaterials.ts:178
set wireframeColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:182

wireframeOpacity

get wireframeOpacity(): number
Determines the opacity of wireframe meshes.

Returns number
- Defined in src/vim-loader/materials/viewerMaterials.ts:191
set wireframeOpacity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:195

Methods

applySettings

applySettings(settings: Settings): void
Updates material settings based on the provided configuration.
Parameters
- settings: Settings
  
  The settings to apply to the materials.
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:92

dispose

dispose(): void
dispose all materials.

Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:318

`Static` createInstance

createInstance(instance: ViewerMaterials): void
Parameters
- instance: ViewerMaterials
Returns void
- Defined in src/vim-loader/materials/viewerMaterials.ts:20

`Static` getInstance

getInstance(): ViewerMaterials
Returns ViewerMaterials
- Defined in src/vim-loader/materials/viewerMaterials.ts:24

Class ViewerMaterials

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional opaque: StandardMaterial

Optional transparent: StandardMaterial

Optional wireframe: LineBasicMaterial

Optional isolation: Material

Optional mask: ShaderMaterial

Optional outline: OutlineMaterial

Optional merge: MergeMaterial

Optional grid: ShaderMaterial

Returns ViewerMaterials

Properties

isolation

mask

merge

opaque

outline

transparent

wireframe

Static instance

Accessors

clippingPlanes

Returns Plane[]

Parameters

value: Plane[]

Returns void

focusColor

Returns Color

Parameters

value: Color

Returns void

focusIntensity

Returns number

Parameters

value: number

Returns void

isolationColor

Returns Color

Parameters

color: Color

Returns void

isolationOpacity

Returns number

Parameters

opacity: number

Returns void

onUpdate

Returns ISignal

outlineBlur

Returns number

Parameters

value: number

Returns void

outlineColor

Returns Color

Parameters

value: Color

Returns void

outlineFalloff

Returns number

Parameters

value: number

Returns void

outlineIntensity

Returns number

Parameters

value: number

Returns void

sectionStrokeColor

Returns Color

Parameters

value: Color

`Optional` opaque: StandardMaterial

`Optional` transparent: StandardMaterial

`Optional` wireframe: LineBasicMaterial

`Optional` isolation: Material

`Optional` mask: ShaderMaterial

`Optional` outline: OutlineMaterial

`Optional` merge: MergeMaterial

`Optional` grid: ShaderMaterial

`Static` instance

`Static` createInstance

`Static` getInstance