Class VertexRendererSettings

A structure that contains settings for a VertexRenderer.

Index

Constructors

Properties

_colorTint _isEnabled _mode

Accessors

colorTint isEnabled mode

Methods

assign clone isEqual isEqual

Constructors

constructor

new VertexRendererSettings(
    isEnabled?: boolean,
    mode?: EnumValue<VertexRendererMode>,
    colorTint?: Immutable<Color>,
): VertexRendererSettings
Parameters
- OptionalisEnabled: boolean
- Optionalmode: EnumValue<VertexRendererMode>
- OptionalcolorTint: Immutable<Color>
Returns VertexRendererSettings

Properties

`Protected`_colorTint

_colorTint: Color

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_mode

_mode: EnumValue<VertexRendererMode>

Accessors

colorTint

get colorTint(): Color

Sets the color which the vertex 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 vertex rendering over the scene geometry.

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

mode

get mode(): EnumValue<VertexRendererMode>

Defines the vertex rendering mode.

Returns EnumValue<VertexRendererMode>
set mode(value: EnumValue<VertexRendererMode>): void
Parameters
- value: EnumValue<VertexRendererMode>
Returns void

Methods

assign

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

clone

clone(): VertexRendererSettings

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

Returns VertexRendererSettings

isEqual

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

`Static`isEqual

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