Class DiagnosticPixelInspectionSettings

A struct that defines the Pixel Inspection settings. The mouse position to cache, and whether is enabled or not.

Index

Constructors

Properties

_apertureSize _isEnabled _isInsideViewportBounds _relativeMouseLocation

Accessors

apertureSize isEnabled isInsideViewportBounds relativeMouseLocation

Methods

assign clone isEqual isEqual

Constructors

constructor

new DiagnosticPixelInspectionSettings(isEnabled?, isInsideViewportBounds?, apertureSize?, relativeMouseLocation?): DiagnosticPixelInspectionSettings
Parameters
- OptionalisEnabled: boolean
- OptionalisInsideViewportBounds: boolean
- OptionalapertureSize: number
- OptionalrelativeMouseLocation: Immutable<Vector2>
Returns DiagnosticPixelInspectionSettings

Properties

`Protected`_apertureSize

_apertureSize: number

`Protected`_isEnabled

_isEnabled: boolean

`Protected`_isInsideViewportBounds

_isInsideViewportBounds: boolean

`Protected`_relativeMouseLocation

_relativeMouseLocation: Vector2

Accessors

apertureSize

get apertureSize(): number
The aperture size to fetch from the pixel data.

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

isEnabled

get isEnabled(): boolean
If it is enabled or not.

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

isInsideViewportBounds

get isInsideViewportBounds(): boolean
If the pointer is inside the scene viewport bounds.

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

relativeMouseLocation

get relativeMouseLocation(): Vector2
The position of the mouse, relative to the viewport screen bounds.

Returns Vector2
set relativeMouseLocation(value): void
Parameters
- value: Immutable<Vector2>
Returns void

Methods

assign

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

clone

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

Returns DiagnosticPixelInspectionSettings

isEqual

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

`Static`isEqual

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