Class EmphasisMaterial

Configures the appearance of ViewObjects when they are xrayed, highlighted or selected.

Located at View.xrayMaterial, View.highlightMaterial and View.selectedMaterial.
XRay a ViewObject by setting ViewObject.xrayed true.
Highlight a ViewObject by setting ViewObject.highlighted true.
Select a ViewObject by setting ViewObject.selected true.

Hierarchy (View Summary)

Component
- EmphasisMaterial

Index

Properties

destroyed

destroyed: boolean

True once this Component has been destroyed.

Don't use this Component if this is true.

`Protected`dirty

dirty: boolean

id

id: string

Unique ID of this Component.

`Readonly`view

view: View

The View to which this EmphasisMaterial belongs.

Accessors

backfaces

get backfaces(): boolean
Gets whether to render backfaces of emphasized ViewObjects when EmphasisMaterial.fill is true.

Default is false.

Returns boolean
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:255
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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:242

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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:212
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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:197

edgeColor

get edgeColor(): Float32Array
Gets the RGB color of the edges of emphasized ViewObjects.

Default is [0.2, 0.2, 0.2].

Returns Float32Array
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:186
set edgeColor(value: FloatArrayParam): void
Sets the RGB color of the edges of emphasized ViewObjects.

Default is [0.2, 0.2, 0.2].
Parameters
- value: FloatArrayParam
Returns void
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:170

edges

get edges(): boolean
Gets if the edges on emphasized ViewObjects are visible.

Default is true.

Returns boolean
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:161
set edges(value: boolean): void
Sets if the edges on emphasized ViewObjects are visible.

Default is true.
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:148

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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:233
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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:221

fill

get fill(): boolean
Gets if the surfaces of emphasized ViewObjects are filled with color.

Default is true.

Returns boolean
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:88
set fill(value: boolean): void
Sets if the surfaces of emphasized ViewObjects are filled with color.

Default is true.
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:75

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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:139
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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:124

fillColor

get fillColor(): Float32Array
Gets the RGB surface fill color for the surfaces of emphasized ViewObjects.

Default is [0.4, 0.4, 0.4].

Returns Float32Array
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:113
set fillColor(value: FloatArrayParam): void
Sets the RGB surface fill color for the surfaces of emphasized ViewObjects.

Default is [0.4, 0.4, 0.4].
Parameters
- value: FloatArrayParam
Returns void
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:97

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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:284
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
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:268

Methods

`Protected`clean

clean(): void
Forces this component to action any deferred state updates.

Returns void
Inherited from Component.clean
- Defined in packages/sdk/src/core/Component.ts:119

`Protected`cleanIfDirty

cleanIfDirty(): void
Gives this component an opportunity to action any defered state updates.

Returns void
Inherited from Component.cleanIfDirty
- Defined in packages/sdk/src/core/Component.ts:109

`Protected`error

error(message: string): void
Protected
Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Parameters
- message: string
  The error message to log
Returns void
Inherited from Component.error
- Defined in packages/sdk/src/core/Component.ts:95

fromParams

fromParams(emphasisMaterialParams: EmphasisMaterialParams): void
Configures this EmphasisMaterial.
Parameters
- emphasisMaterialParams: EmphasisMaterialParams
Returns void
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:299

`Protected`log

log(message: string): void
Protected
Logs a message for this component.

The message will have this format: [LOG] [<component type> <component id>: <message>
Parameters
- message: string
  The message to log
Returns void
Inherited from Component.log
- Defined in packages/sdk/src/core/Component.ts:71

`Protected`setDirty

setDirty(): void
Flags this component as having a defered state updates it needs to perform.

Returns void
Inherited from Component.setDirty
- Defined in packages/sdk/src/core/Component.ts:102

toParams

toParams(): EmphasisMaterialParams
Gets the current configuration of this EmphasisMaterial.

Returns EmphasisMaterialParams
- Defined in packages/sdk/src/viewer/EmphasisMaterial.ts:332

`Protected`warn

warn(message: string): void
Protected
Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>
Parameters
- message: string
  The warning message to log
Returns void
Inherited from Component.warn
- Defined in packages/sdk/src/core/Component.ts:83

Events

onDestroyed

onDestroyed: EventEmitter<Component, null>

Emits an event when the Component has been destroyed.

Class EmphasisMaterial

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Events

Properties

destroyed

Protecteddirty

id

Readonlyview

Accessors

backfaces

Returns boolean

Parameters

Returns void

edgeAlpha

Returns number

Parameters

Returns void

edgeColor

Returns Float32Array

Parameters

Returns void

edges

Returns boolean

Parameters

Returns void

edgeWidth

Returns number

Parameters

Returns void

fill

Returns boolean

Parameters

Returns void

fillAlpha

Returns number

Parameters

Returns void

fillColor

Returns Float32Array

Parameters

Returns void

glowThrough

Returns boolean

Parameters

Returns void

Methods

Protectedclean

Returns void

ProtectedcleanIfDirty

Returns void

Protectederror

Parameters

Returns void

fromParams

Parameters

Returns void

Protectedlog

Parameters

Returns void

ProtectedsetDirty

Returns void

toParams

Returns EmphasisMaterialParams

Protectedwarn

Parameters

Returns void

Events

onDestroyed

Settings

On This Page

`Protected`dirty

`Readonly`view

`Protected`clean

`Protected`cleanIfDirty

`Protected`error

`Protected`log

`Protected`setDirty

`Protected`warn