Class Materials

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

Hierarchy

Materials

Index

Constructors

constructor

new Materials(opaque?: StandardMaterial, transparent?: StandardMaterial, wireframe?: LineBasicMaterial, isolation?: THREE.Material, mask?: ShaderMaterial, outline?: OutlineMaterial, merge?: MergeMaterial, grid?: ShaderMaterial): Materials
Parameters
- Optional opaque: StandardMaterial
- Optional transparent: StandardMaterial
- Optional wireframe: LineBasicMaterial
- Optional isolation: THREE.Material
- Optional mask: ShaderMaterial
- Optional outline: OutlineMaterial
- Optional merge: MergeMaterial
- Optional grid: ShaderMaterial
Returns Materials
- Defined in src/materials/materials.ts:67

Properties

grid

grid: ShaderMaterial

isolation

isolation: THREE.Material

mask

mask: ShaderMaterial

merge

merge: MergeMaterial

opaque

opaque: StandardMaterial

outline

outline: OutlineMaterial

transparent

transparent: StandardMaterial

wireframe

wireframe: LineBasicMaterial

Accessors

clippingPlanes

get clippingPlanes(): Plane[]
Returns Plane[]
- Defined in src/materials/materials.ts:176
set clippingPlanes(value: Plane[]): void
Parameters
- value: Plane[]
Returns void
- Defined in src/materials/materials.ts:180

focusColor

get focusColor(): Color
Returns Color
- Defined in src/materials/materials.ts:143
set focusColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/materials/materials.ts:147

focusIntensity

get focusIntensity(): number
Returns number
- Defined in src/materials/materials.ts:131
set focusIntensity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:135

isolationColor

get isolationColor(): Color
Returns Color
- Defined in src/materials/materials.ts:119
set isolationColor(color: Color): void
Parameters
- color: Color
Returns void
- Defined in src/materials/materials.ts:124

isolationOpacity

get isolationOpacity(): number
Returns number
- Defined in src/materials/materials.ts:108
set isolationOpacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in src/materials/materials.ts:112

onUpdate

get onUpdate(): ISignal
Returns ISignal
- Defined in src/materials/materials.ts:104

outlineBlur

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

Returns number
- Defined in src/materials/materials.ts:253
set outlineBlur(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:257

outlineColor

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

Returns Color
- Defined in src/materials/materials.ts:240
set outlineColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/materials/materials.ts:244

outlineFalloff

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

Returns number
- Defined in src/materials/materials.ts:266
set outlineFalloff(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:270

outlineIntensity

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

Returns number
- Defined in src/materials/materials.ts:279
set outlineIntensity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:283

sectionStrokeColor

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

Returns Color
- Defined in src/materials/materials.ts:225
set sectionStrokeColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/materials/materials.ts:229

sectionStrokeFalloff

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

Returns number
- Defined in src/materials/materials.ts:210
set sectionStrokeFalloff(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:214

sectionStrokeWidth

get sectionStrokeWidth(): number
Width of the stroke effect where the section box intersects the model.

Returns number
- Defined in src/materials/materials.ts:195
set sectionStrokeWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:199

wireframeColor

get wireframeColor(): Color
Returns Color
- Defined in src/materials/materials.ts:155
set wireframeColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/materials/materials.ts:159

wireframeOpacity

get wireframeOpacity(): number
Returns number
- Defined in src/materials/materials.ts:165
set wireframeOpacity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/materials/materials.ts:169

Methods

applySettings

applySettings(settings: MaterialSettings): void
Parameters
- settings: MaterialSettings
Returns void
- Defined in src/materials/materials.ts:87

dispose

dispose(): void
dispose all materials.

Returns void
- Defined in src/materials/materials.ts:290

`Static` getInstance

getInstance(): Materials
Returns Materials
- Defined in src/materials/materials.ts:43

Generated using TypeDoc