Class Effect

Readonlyview

backfaces

• get backfaces(): boolean

  Gets whether to render backfaces for style-bin surfaces when Effect.fill is true.

  Default is false.

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

  Sets whether to render backfaces for style-bin surfaces when Effect.fill is true.

  Default is false.

  Parameters

  • value: boolean

  Returns void

clearDepthBefore

• get clearDepthBefore(): boolean

  Gets whether to clear the depth buffer before rendering this style bin.

  Default is false.

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

  Sets whether to clear the depth buffer before rendering this style bin.

  When true, objects in this style bin are also rendered in a depth-cleared style-bin pass, making the bin treatment visible through occluding geometry while leaving the object's normal rendering treatment intact.

  Default is false.

  Note: updating this property marks the View dirty but does not change membership.

  Parameters

  • value: boolean

  Returns void

edgeAlpha

• get edgeAlpha(): number

  Gets the transparency of style-bin edges.

  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 style-bin edges.

  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 style-bin edges.

  Default is [0.2, 0.2, 0.2].

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

  Sets the RGB color of style-bin edges.

  Default is [0.2, 0.2, 0.2].

  Parameters

  • value: Vec3

  Returns void

edges

• get edges(): boolean

  Gets if style-bin edges are visible.

  Default is true.

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

  Sets if style-bin edges are visible.

  Default is true.

  Parameters

  • value: boolean

  Returns void

edgeWidth

• get edgeWidth(): number

  Gets the width of style-bin edges.

  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 style-bin edges.

  Default value is 1.0 pixels.

  Parameters

  • value: number

  Returns void

fill

• get fill(): boolean

  Gets if style-bin surfaces are filled with color.

  Default is true.

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

  Sets if style-bin surfaces are filled with color.

  Default is true.

  Parameters

  • value: boolean

  Returns void

fillAlpha

• get fillAlpha(): number

  Gets the transparency of style-bin surfaces.

  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 style-bin surfaces.

  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 style-bin surfaces.

  Default is [0.4, 0.4, 0.4].

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

  Sets the RGB surface fill color for style-bin surfaces.

  Default is [0.4, 0.4, 0.4].

  Parameters

  • value: Vec3

  Returns void

fromParams

• fromParams(effectParams: EffectParams): SDKResult<any>

  Configures this Effect.

  Parameters

  • effectParams: EffectParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<EffectParams>

  Gets the current configuration of this Effect.

  Returns SDKResult<EffectParams>