Class WireframeRendererSettings

A structure that contains settings for a WireframeRenderer.

Index

Constructors

Properties

_colorTint _isBackfaceCulling _isEnabled _mode _thickness

Accessors

colorTint isBackfaceCulling isEnabled mode thickness

Methods

assign clone isEqual isEqual

Constructors

constructor

new WireframeRendererSettings(
    isEnabled?: boolean,
    mode?: EnumValue<WireframeRendererMode>,
    colorTint?: Immutable<SRGBColor>,
    thickness?: number,
    isBackfaceCulling?: boolean,
): WireframeRendererSettings
Parameters
- OptionalisEnabled: boolean
- Optionalmode: EnumValue<WireframeRendererMode>
- OptionalcolorTint: Immutable<SRGBColor>
- Optionalthickness: number
- OptionalisBackfaceCulling: boolean
Returns WireframeRendererSettings

Properties

`Protected`_colorTint

_colorTint: SRGBColor

`Protected`_isBackfaceCulling

_isBackfaceCulling: boolean

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_mode

_mode: EnumValue<WireframeRendererMode>

`Protected`_thickness

_thickness: number

Accessors

colorTint

get colorTint(): SRGBColor

Sets the color which the wireframe is rendered with.

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

isBackfaceCulling

get isBackfaceCulling(): boolean

Determins if triangles facing away from the camera should be drawn.

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

isEnabled

get isEnabled(): boolean

Enables or disables the wireframe rendering over the scene geometry.

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

mode

get mode(): EnumValue<WireframeRendererMode>

Defines the wireframe rendering mode.

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

thickness

get thickness(): number

The thickness in pixels of the drawn wireframe lines.

Returns number
set thickness(value: number): void
Parameters
- value: number
Returns void

Methods

assign

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

clone

clone(): WireframeRendererSettings

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

Returns WireframeRendererSettings

isEqual

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

`Static`isEqual

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