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

Communicator.Settings.HiddenLineSettings.getBackgroundColor()

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

Return type

Communicator.VerticalGradient

Returns

The background colors used for hidden line.

getObscuredLineColor

Communicator.Settings.HiddenLineSettings.getObscuredLineColor()

Returns the Color used for rendering obscured lines.

Return type

Communicator.Color

Returns

The color used for obscured lines.

getObscuredLineOpacity

Communicator.Settings.HiddenLineSettings.getObscuredLineOpacity()

Returns the opacity used for rendering obscured lines.

Return type

number

Returns

The opacity used for obscured lines.

getObscuredLineTransparency

Communicator.Settings.HiddenLineSettings.getObscuredLineTransparency()

Note

getObscuredLineTransparency is deprecated: use getObscuredLineOpacity instead.

Return type

number

getVisibleLineColor

Communicator.Settings.HiddenLineSettings.getVisibleLineColor()

Gets the Color used for rendering visible lines.

Return type

Communicator.Color

Returns

The color used for visible lines.

getVisibleLineOpacity

Communicator.Settings.HiddenLineSettings.getVisibleLineOpacity()

Gets the opacity used for rendering visible lines.

Return type

number

Returns

The opacity used for visible lines.

getVisibleLineTransparency

Communicator.Settings.HiddenLineSettings.getVisibleLineTransparency()

Note

getVisibleLineTransparency is deprecated: use getVisibleLineOpacity instead.

Return type

number

setBackgroundColor

Communicator.Settings.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 ({  }()) – the top color for the the background gradient, null for transparent.

  • bottom ({  }()) – the bottom color for the the background gradient, null for transparent.

Return type

void

setObscuredLineColor

Communicator.Settings.HiddenLineSettings.setObscuredLineColor(color)

Sets the Color used for rendering obscured lines.

Arguments
  • color (Communicator.Color()) – The color used for obscured lines.

Return type

void

setObscuredLineOpacity

Communicator.Settings.HiddenLineSettings.setObscuredLineOpacity(opacity)

Sets the opacity used for rendering obscured lines.

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

Return type

void

setObscuredLineTransparency

Communicator.Settings.HiddenLineSettings.setObscuredLineTransparency(transparency)

Note

setObscuredLineTransparency is deprecated: use setObscuredLineOpacity instead.

Arguments
  • transparency (number()) –

Return type

void

setVisibleLineColor

Communicator.Settings.HiddenLineSettings.setVisibleLineColor(color)

Sets the Color used for rendering visible lines.

Arguments
  • color (Communicator.Color()) – The color used for visible lines.

Return type

void

setVisibleLineOpacity

Communicator.Settings.HiddenLineSettings.setVisibleLineOpacity(opacity)

Sets the opacity used for rendering visible lines.

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

Return type

void

setVisibleLineTransparency

Communicator.Settings.HiddenLineSettings.setVisibleLineTransparency(transparency)

Note

setVisibleLineTransparency is deprecated: use setVisibleLineOpacity instead.

Arguments
  • transparency (number()) –

Return type

void