Class SelectionHighlightRendererSettings

A structure that contains settings for a SelectionHighlightRenderer.

Index

Constructors

Properties

_colorTint _isEnabled

Accessors

colorTint isEnabled

Methods

assign clone isEqual isEqual

Constructors

constructor

new SelectionHighlightRendererSettings(
isEnabled?: boolean,
colorTint?: Immutable<Color>,
): SelectionHighlightRendererSettings
Parameters
- OptionalisEnabled: boolean
- OptionalcolorTint: Immutable<Color>
Returns SelectionHighlightRendererSettings

Properties

`Protected`_colorTint

_colorTint: Color

`Protected`_isEnabled

_isEnabled: boolean

Accessors

colorTint

get colorTint(): Color

Sets the color which the selection highlights is rendered with.

Returns Color
set colorTint(value: Immutable<Color>): void
Parameters
- value: Immutable<Color>
Returns void

isEnabled

get isEnabled(): boolean

Enables or disables the selection highlights rendering over the scene geometry.

Returns boolean
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

Methods

assign

assign(
other: Immutable<SelectionHighlightRendererSettings>,
): SelectionHighlightRendererSettings
Copies all properties defined by the prototype of SelectionHighlightRendererSettings from other to this instance.
Parameters
- other: Immutable<SelectionHighlightRendererSettings>
Returns SelectionHighlightRendererSettings

clone

clone(): SelectionHighlightRendererSettings

Clones this instance and returns a new SelectionHighlightRendererSettings with identical values.

Returns SelectionHighlightRendererSettings

isEqual

isEqual(
this: Immutable<SelectionHighlightRendererSettings>,
other: Immutable<SelectionHighlightRendererSettings>,
): boolean
Determines if this SelectionHighlightRendererSettings instance is equal to the other instance.
Parameters
- this: Immutable<SelectionHighlightRendererSettings>
- other: Immutable<SelectionHighlightRendererSettings>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<SelectionHighlightRendererSettings>,
rhs: Immutable<SelectionHighlightRendererSettings>,
): boolean
Determines if both SelectionHighlightRendererSettings instances are equal.
Parameters
- lhs: Immutable<SelectionHighlightRendererSettings>
- rhs: Immutable<SelectionHighlightRendererSettings>
Returns boolean