Class DiagnosticView

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

Index

Constructors

Accessors

isEnabled normalizedViewportLocation type

Methods

markAsDirty modify

Constructors

constructor

new DiagnosticView(isInternalConstructor?: boolean): DiagnosticView
Parameters
- OptionalisInternalConstructor: boolean
Returns DiagnosticView

Overrides FrameworkObject.constructor

Accessors

isEnabled

get isEnabled(): boolean

If it is enabled or not.

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

normalizedViewportLocation

get normalizedViewportLocation(): Immutable<Rect2>

The position and size of the Diagnostic View on the Viewport. This is where the Diagnostic View should be drawn. This should be normalized. Meaning this values must be set from 0-1. This is set automatically by the Engine, but can be set manually on a stand-alone framework.

Returns Immutable<Rect2>
set normalizedViewportLocation(value: Immutable<Rect2>): void
Parameters
- value: Immutable<Rect2>
Returns void

type

get type(): EnumValue<DiagnosticViewType>

The type of the view.

Returns EnumValue<DiagnosticViewType>
set type(value: EnumValue<DiagnosticViewType>): void
Parameters
- value: EnumValue<DiagnosticViewType>
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