Class Edges

Configures edge enhancement effect for a View.

Located at View.edges.
View will apply edge enhancement when View.renderMode is set to one of the values specified in Edges.renderModes.

See @xeokit/sdk/viewer for usage info.

Hierarchy (View Summary)

Component
- Edges

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 Edges belongs.

Accessors

applied

get applied(): boolean
Gets if edges are currently applied.

This is true when View.renderMode is in Edges.renderModes.

Returns boolean
- Defined in packages/sdk/src/viewer/Edges.ts:155

edgeAlpha

get edgeAlpha(): number
Gets edge transparency for ViewObjects.

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

Default value is 1.0.

Returns number
- Defined in packages/sdk/src/viewer/Edges.ts:121
set edgeAlpha(value: number): void
Sets edge transparency for ViewObjects.

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

Default value is 1.0.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/Edges.ts:106

edgeColor

get edgeColor(): FloatArrayParam
Gets RGB edge color for ViewObjects.

Default value is [0.2, 0.2, 0.2].

Returns FloatArrayParam
- Defined in packages/sdk/src/viewer/Edges.ts:95
set edgeColor(value: FloatArrayParam): void
Sets RGB edge color for ViewObjects.

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

edgeWidth

get edgeWidth(): number
Gets edge width for 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/Edges.ts:145
set edgeWidth(value: number): void
Sets edge width for ViewObjects.

Default value is 1.0 pixels.
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewer/Edges.ts:130

renderModes

get renderModes(): number[]
Gets which rendering modes in which to show edges on ViewObjects.

The View will show edges whenever View.renderMode has been set one of these values.

Default value is [QualityRender].

Returns number[]
- Defined in packages/sdk/src/viewer/Edges.ts:70
set renderModes(value: number[]): void
Sets which rendering modes in which to show edges on ViewObjects.

The View will show edges whenever View.renderMode has been set one of these values.

Default value is [QualityRender].
Parameters
- value: number[]
Returns void
- Defined in packages/sdk/src/viewer/Edges.ts:58

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(edgesParams: EdgesParams): void
Configures this Edges effect.
Parameters
- edgesParams: EdgesParams
Returns void
- Defined in packages/sdk/src/viewer/Edges.ts:181

`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(): EdgesParams
Gets the current configuration of this Edges effect.

Returns EdgesParams
- Defined in packages/sdk/src/viewer/Edges.ts:167

`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 Edges

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Events

Properties

destroyed

Protecteddirty

id

Readonlyview

Accessors

applied

Returns boolean

edgeAlpha

Returns number

Parameters

Returns void

edgeColor

Returns FloatArrayParam

Parameters

Returns void

edgeWidth

Returns number

Parameters

Returns void

renderModes

Returns number[]

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 EdgesParams

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