Class EmphasisMaterial

Readonlyview

backfaces

• get backfaces(): boolean

  Gets whether to render backfaces of emphasized ViewObjects when EmphasisMaterial.fill is true.

  Default is false.

  Returns boolean
• set backfaces(value: boolean): void

  Sets whether to render backfaces of emphasized ViewObjects when EmphasisMaterial.fill is true.

  Default is false.

  Parameters

  • value: boolean

  Returns void

edgeAlpha

• get edgeAlpha(): number

  Gets the transparency of the edges of emphasized ViewObjects.

  A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

  Default is 0.2.

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

  Sets the transparency of the edges of emphasized ViewObjects.

  A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

  Default is 0.2.

  Parameters

  • value: number

  Returns void

edgeColor

• get edgeColor(): Vec3

  Gets the RGB color of the edges of emphasized ViewObjects.

  Default is [0.2, 0.2, 0.2].

  Returns Vec3
• set edgeColor(value: Vec3): void

  Sets the RGB color of the edges of emphasized ViewObjects.

  Default is [0.2, 0.2, 0.2].

  Parameters

  • value: Vec3

  Returns void

edges

• get edges(): boolean

  Gets if the edges on emphasized ViewObjects are visible.

  Default is true.

  Returns boolean
• set edges(value: boolean): void

  Sets if the edges on emphasized ViewObjects are visible.

  Default is true.

  Parameters

  • value: boolean

  Returns void

edgeWidth

• get edgeWidth(): number

  Gets the width of the edges of emphasized ViewObjects.

  This is not supported by WebGL implementations based on DirectX [2019].

  Default value is 1.0 pixels.

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

  Sets the width of the edges of emphasized ViewObjects.

  Default value is 1.0 pixels.

  Parameters

  • value: number

  Returns void

fill

• get fill(): boolean

  Gets if the surfaces of emphasized ViewObjects are filled with color.

  Default is true.

  Returns boolean
• set fill(value: boolean): void

  Sets if the surfaces of emphasized ViewObjects are filled with color.

  Default is true.

  Parameters

  • value: boolean

  Returns void

fillAlpha

• get fillAlpha(): number

  Gets the transparency of the surfaces of emphasized ViewObjects.

  A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

  Default is 0.2.

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

  Sets the transparency of the surfaces of emphasized ViewObjects.

  A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

  Default is 0.2.

  Parameters

  • value: number

  Returns void

fillColor

• get fillColor(): Vec3

  Gets the RGB surface fill color for the surfaces of emphasized ViewObjects.

  Default is [0.4, 0.4, 0.4].

  Returns Vec3
• set fillColor(value: Vec3): void

  Sets the RGB surface fill color for the surfaces of emphasized ViewObjects.

  Default is [0.4, 0.4, 0.4].

  Parameters

  • value: Vec3

  Returns void

glowThrough

• get glowThrough(): boolean

  Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".

  Default is true.

  Returns boolean
• set glowThrough(value: boolean): void

  Sets whether to render emphasized objects over the top of other objects, as if they were "glowing through".

  Default is true.

  Note: updating this property will not affect the appearance of objects that are already emphasized.

  Parameters

  • value: boolean

  Returns void

fromParams

• fromParams(emphasisMaterialParams: EmphasisMaterialParams): SDKResult<any>

  Configures this EmphasisMaterial.

  Parameters

  • emphasisMaterialParams: EmphasisMaterialParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<EmphasisMaterialParams>

  Gets the current configuration of this EmphasisMaterial.

  Returns SDKResult<EmphasisMaterialParams>