Class DiagnosticPixelInspectionSettings

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Index

Constructors

Accessors

apertureSize isEnabled isInsideViewportBounds relativeMouseLocation

Methods

markAsDirty modify

Constructors

`Protected`constructor

new DiagnosticPixelInspectionSettings(
isInternalConstructor?: boolean,
): DiagnosticPixelInspectionSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns DiagnosticPixelInspectionSettings

Overrides FrameworkObject.constructor

Accessors

apertureSize

get apertureSize(): number

The aperture size to fetch from the pixel data.

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

isEnabled

get isEnabled(): boolean

If it is enabled or not.

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

isInsideViewportBounds

get isInsideViewportBounds(): boolean

If the pointer is inside the scene viewport bounds.

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

relativeMouseLocation

get relativeMouseLocation(): Immutable<rsx.UIPixel>

The position of the mouse, relative to the viewport screen bounds.

Returns Immutable<rsx.UIPixel>
set relativeMouseLocation(value: Immutable<rsx.UIPixel>): void
Parameters
- value: Immutable<rsx.UIPixel>
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): void
Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.
Parameters
- action: () => void
  The scope where the object is modified.
Returns void