Class ViewerMaterials

constructor

• new ViewerMaterials(
      opaque?: StandardMaterial,
      transparent?: StandardMaterial,
      simple?: Material,
      wireframe?: LineBasicMaterial,
      ghost?: Material,
      mask?: ShaderMaterial,
      outline?: OutlineMaterial,
      merge?: MergeMaterial,
      skyBox?: SkyboxMaterial,
  ): ViewerMaterials

• Parameters

  • Optionalopaque: StandardMaterial
  • Optionaltransparent: StandardMaterial
  • Optionalsimple: Material
  • Optionalwireframe: LineBasicMaterial
  • Optionalghost: Material
  • Optionalmask: ShaderMaterial
  • Optionaloutline: OutlineMaterial
  • Optionalmerge: MergeMaterial
  • OptionalskyBox: SkyboxMaterial

  Returns ViewerMaterials

Readonlyghost

Readonlymask

Readonlymerge

Readonlyopaque

Readonlyoutline

Readonlysimple

ReadonlyskyBox

Readonlytransparent

Readonlywireframe

Staticinstance

clippingPlanes

• get clippingPlanes(): Plane[]

• The clipping planes applied to all relevent materials

  Returns Plane[]
• set clippingPlanes(value: Plane[]): void

• Parameters

  • value: Plane[]

  Returns void

focusColor

• get focusColor(): Color

• Determines the color of the highlight effect on mouse hover.

  Returns Color
• set focusColor(value: Color): void

• Parameters

  • value: Color

  Returns void

focusIntensity

• get focusIntensity(): number

• Determines the color intensity of the highlight effect on mouse hover.

  Returns number
• set focusIntensity(value: number): void

• Parameters

  • value: number

  Returns void

ghostColor

• get ghostColor(): Color

• Determines the color of the ghost material.

  Returns Color
• set ghostColor(color: Color): void

• Parameters

  • color: Color

  Returns void

ghostOpacity

• get ghostOpacity(): number

• Determines the opacity of the ghost material.

  Returns number
• set ghostOpacity(opacity: number): void

• Parameters

  • opacity: number

  Returns void

modelColor

• get modelColor(): Color

• Determines the color of the model regular opaque and transparent materials.

  Returns Color
• set modelColor(color: Color): void

• Parameters

  • color: Color

  Returns void

onUpdate

• get onUpdate(): ISignal

• A signal dispatched whenever a material is modified.

  Returns ISignal

outlineAntialias

• get outlineAntialias(): boolean

• Returns boolean

• set outlineAntialias(value: boolean): void

• Parameters

  • value: boolean

  Returns void

outlineBlur

• get outlineBlur(): number

• Size of the blur convolution on the selection outline effect. Minimum 2.

  Returns number
• set outlineBlur(value: number): void

• Parameters

  • value: number

  Returns void

outlineColor

• get outlineColor(): Color

• Color of the selection outline effect.

  Returns Color
• set outlineColor(value: Color): void

• Parameters

  • value: Color

  Returns void

outlineFalloff

• get outlineFalloff(): number

• Gradient of the the selection outline effect.

  Returns number
• set outlineFalloff(value: number): void

• Parameters

  • value: number

  Returns void

outlineIntensity

• get outlineIntensity(): number

• Intensity of the the selection outline effect.

  Returns number
• set outlineIntensity(value: number): void

• Parameters

  • value: number

  Returns void

sectionStrokeColor

• get sectionStrokeColor(): Color

• Color of the stroke effect where the section box intersects the model.

  Returns Color
• set sectionStrokeColor(value: Color): void

• Parameters

  • value: Color

  Returns void

sectionStrokeFallof

• get sectionStrokeFallof(): number

• Gradient of the stroke effect where the section box intersects the model.

  Returns number
• set sectionStrokeFallof(value: number): void

• Parameters

  • value: number

  Returns void

sectionStrokeWitdh

• get sectionStrokeWitdh(): number

• The width of the stroke effect where the section box intersects the model.

  Returns number
• set sectionStrokeWitdh(value: number): void

• Parameters

  • value: number

  Returns void

skyboxGroundColor

• get skyboxGroundColor(): Color

• Returns Color

• set skyboxGroundColor(value: Color): void

• Parameters

  • value: Color

  Returns void

skyboxSharpness

• get skyboxSharpness(): number

• Returns number

• set skyboxSharpness(value: number): void

• Parameters

  • value: number

  Returns void

skyboxSkyColor

• get skyboxSkyColor(): Color

• Returns Color

• set skyboxSkyColor(value: Color): void

• Parameters

  • value: Color

  Returns void

wireframeColor

• get wireframeColor(): Color

• Determines the color of wireframe meshes.

  Returns Color
• set wireframeColor(value: Color): void

• Parameters

  • value: Color

  Returns void

wireframeOpacity

• get wireframeOpacity(): number

• Determines the opacity of wireframe meshes.

  Returns number
• set wireframeOpacity(value: number): void

• Parameters

  • value: number

  Returns void

applySettings

• applySettings(settings: ViewerSettings): void

• Updates material settings based on the provided configuration.

  Parameters

  • settings: ViewerSettings

    The settings to apply to the materials.

  Returns void

dispose

• dispose(): void

• dispose all materials.

  Returns void

StaticcreateInstance

• createInstance(instance: ViewerMaterials): void

• Parameters

  • instance: ViewerMaterials

  Returns void

StaticgetInstance

• getInstance(): ViewerMaterials

• Returns ViewerMaterials