Class NormalsRendererSettings

A structure that contains settings for a NormalsRenderer.

Index

Constructors

Properties

_colorTint _isEnabled _length _mode

Accessors

colorTint isEnabled length mode

Methods

assign clone isEqual isEqual

Constructors

constructor

new NormalsRendererSettings(isEnabled?, mode?, colorTint?, length?): NormalsRendererSettings
Parameters
- OptionalisEnabled: boolean
- Optionalmode: EnumValue<NormalsRendererMode, number>
- OptionalcolorTint: Immutable<Color>
- Optionallength: number
Returns NormalsRendererSettings

Properties

`Protected`_colorTint

_colorTint: Color

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_length

_length: number

`Protected`_mode

_mode: EnumValue<NormalsRendererMode, number>

Accessors

colorTint

get colorTint(): Color
Sets the color which the normals is rendered with.

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

isEnabled

get isEnabled(): boolean
Enables or disables the normals rendering over the scene geometry.

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

length

get length(): number
The length to render the normal vector with.

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

mode

get mode(): EnumValue<NormalsRendererMode, number>
Defines the normals rendering mode.

Returns EnumValue<NormalsRendererMode, number>
set mode(value): void
Parameters
- value: EnumValue<NormalsRendererMode, number>
Returns void

Methods

assign

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

clone

clone(): NormalsRendererSettings
Clones this instance and returns a new NormalsRendererSettings with identical values.

Returns NormalsRendererSettings

isEqual

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

`Static`isEqual

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