Class Edges

Readonlyview

applied

• get applied(): boolean

  Gets if edges are currently applied.

  This is true when the component enabled state is in the component enabled state.

  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 0.8.

  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 0.8.

  Parameters

  • value: number

  Returns void

edgeColor

• get edgeColor(): Vec3

  Gets RGB edge color for ViewObjects.

  Default value is [0.35, 0.35, 0.35].

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

  Sets RGB edge color for ViewObjects.

  Default value is [0.35, 0.35, 0.35].

  Parameters

  • value: Vec3

  Returns void

edgeDarken

• get edgeDarken(): number

  Gets the multiplier applied to each mesh's colour when useMeshColor is true.

  Default value is 0.5.

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

  Sets the multiplier applied to each mesh's colour when useMeshColor is true.

  0 yields black edges, 1 leaves the mesh colour unchanged.

  Default value is 0.5.

  Parameters

  • value: number

  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

enabled

• get enabled(): boolean

  Returns boolean

• set enabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

useMeshColor

• get useMeshColor(): boolean

  Gets whether the base edges effect uses each mesh's darkened colour instead of the fixed edgeColor.

  Default value is true.

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

  Sets whether the base edges effect colours each edge with its own mesh's colour darkened by edgeDarken, instead of the fixed edgeColor.

  Only affects the base edges effect. Edges drawn by a style bin use that bin's edge colour.

  Default value is true.

  Parameters

  • value: boolean

  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>