HiddenLineSettings

class Communicator.Settings.HiddenLineSettings(): This class controls settings used in hidden line rendering. Settings get applied when View.setDrawMode(DrawMode.HiddenLine) is called.

Methods

getBackgroundColor()
getObscuredLineColor()
getObscuredLineOpacity()
getObscuredLineTransparency()
getVisibleLineColor()
getVisibleLineOpacity()
getVisibleLineTransparency()
setBackgroundColor()
setObscuredLineColor()
setObscuredLineOpacity()
setObscuredLineTransparency()
setVisibleLineColor()
setVisibleLineOpacity()
setVisibleLineTransparency()

Methods

getBackgroundColor

HiddenLineSettings.getBackgroundColor()

Gets the colors used for the background in hidden line rendering.

Return type: VerticalGradient()
Returns: The background colors used for hidden line.

getObscuredLineColor

HiddenLineSettings.getObscuredLineColor()

Returns the Color used for rendering obscured lines.

Return type: Color()
Returns: The color used for obscured lines.

getObscuredLineOpacity

HiddenLineSettings.getObscuredLineOpacity()

Returns the opacity used for rendering obscured lines.

Return type: number
Returns: The opacity used for obscured lines.

getObscuredLineTransparency

HiddenLineSettings.getObscuredLineTransparency()

Deprecated: use getObscuredLineOpacity instead.
Return type: number

getVisibleLineColor

HiddenLineSettings.getVisibleLineColor()

Gets the Color used for rendering visible lines.

Return type: Color()
Returns: The color used for visible lines.

getVisibleLineOpacity

HiddenLineSettings.getVisibleLineOpacity()

Gets the opacity used for rendering visible lines.

Return type: number
Returns: The opacity used for visible lines.

getVisibleLineTransparency

HiddenLineSettings.getVisibleLineTransparency()

Deprecated: use getVisibleLineOpacity instead.
Return type: number

setBackgroundColor

HiddenLineSettings.setBackgroundColor([top[, bottom]])

Sets the background color in hidden line rendering to a gradient interpolating from the top to bottom color. For a solid color, the top and bottom color should have the same values. To enable a transparent background, pass null to the parameters of this function.

Arguments

top (Color() | null) – optional the top color for the the background gradient, null for transparent.
bottom (Color() | null) – optional the bottom color for the the background gradient, null for transparent.

Return type

void

setObscuredLineColor

HiddenLineSettings.setObscuredLineColor(color)

Sets the Color used for rendering obscured lines.

Arguments

color (Color()) – The color used for obscured lines.

Return type

void

setObscuredLineOpacity

HiddenLineSettings.setObscuredLineOpacity(opacity)

Sets the opacity used for rendering obscured lines.

Arguments

opacity (number()) – The opacity used for obscured lines.

Return type

void

setObscuredLineTransparency

HiddenLineSettings.setObscuredLineTransparency(transparency)

Deprecated

use setObscuredLineOpacity instead.

Arguments

transparency (number()) –

Return type

void

setVisibleLineColor

HiddenLineSettings.setVisibleLineColor(color)

Sets the Color used for rendering visible lines.

Arguments

color (Color()) – The color used for visible lines.

Return type

void

setVisibleLineOpacity

HiddenLineSettings.setVisibleLineOpacity(opacity)

Sets the opacity used for rendering visible lines.

Arguments

opacity (number()) – The opacity used for visible lines.

Return type

void

setVisibleLineTransparency

HiddenLineSettings.setVisibleLineTransparency(transparency)

Deprecated

use setVisibleLineOpacity instead.

Arguments

transparency (number()) –

Return type

void