Class Edges

Readonlyview

applied

• get applied(): boolean

  Gets if edges are currently applied.

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

  Returns boolean

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
• 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

edgeColor

• get edgeColor(): Vec3

  Gets RGB edge color for ViewObjects.

  Default value is [0.2, 0.2, 0.2].

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

  Sets RGB edge color for ViewObjects.

  Default value is [0.2, 0.2, 0.2].

  Parameters

  • value: Vec3

  Returns void

edgeFadeEnd

• get edgeFadeEnd(): number

  Gets the fraction of the active camera's far plane at which edges become fully transparent.

  Default value is 1.0.

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

  Sets the fraction of the active camera's far plane at which edges become fully transparent.

  Default value is 1.0.

  Parameters

  • value: number

  Returns void

edgeFadeStart

• get edgeFadeStart(): number

  Gets the fraction of the active camera's far plane at which edge fade-out begins.

  Default value is 0.4.

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

  Sets the fraction of the active camera's far plane at which edge fade-out begins.

  Smoothly attenuates edge alpha with view-space depth so distant edges stop crowding into a dark mass — most visible in x-ray and silhouette modes. Edges closer than this remain at full intensity. Range is [0, 1]; set this >= edgeFadeEnd to disable the fade.

  Default value is 0.4.

  Parameters

  • value: number

  Returns void

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
• set edgeWidth(value: number): void

  Sets edge width for ViewObjects.

  Default value is 1.0 pixels.

  Parameters

  • value: number

  Returns void

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 [DetailedRender].

  Returns number[]
• 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 [DetailedRender].

  Parameters

  • value: number[]

  Returns void

fromParams

• fromParams(edgesParams: EdgesParams): SDKResult<any>

  Configures this Edges effect.

  Parameters

  • edgesParams: EdgesParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<EdgesParams>

  Gets the current configuration of this Edges effect.

  Returns SDKResult<EdgesParams>