Class SceneWindowSettings

The SceneWindowSettings class contains user specific settings for the SceneWindow.

Hierarchy (view full)

UserProjectSettingsBase<SceneWindowSettings>
- SceneWindowSettings

Index

Constructors

Properties

normalsSettings scrollOutlinerToSelection selectionHighlight showSelectionInformation vertexSettings wireframeSettings

Accessors

Methods

assign markAsDirty

Events

Constructors

constructor

new SceneWindowSettings(): SceneWindowSettings
Returns SceneWindowSettings
Inherited from UserProjectSettingsBase.constructor

Properties

normalsSettings

normalsSettings: NormalsRendererSettings

scrollOutlinerToSelection

scrollOutlinerToSelection: boolean

Determines if the outliner will scroll the selected item to be visible if the selection changes.

selectionHighlight

selectionHighlight: SelectionHighlightRendererSettings

showSelectionInformation

showSelectionInformation: boolean

vertexSettings

vertexSettings: VertexRendererSettings

wireframeSettings

wireframeSettings: WireframeRendererSettings

Accessors

isGlobal

get isGlobal(): boolean
Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

Returns boolean
Overrides UserProjectSettingsBase.isGlobal

Methods

assign

assign(other): void
Copies all properties defined by the prototype of other to this instance.
Parameters
- other: Readonly<SceneWindowSettings>
Returns void
Inherited from UserProjectSettingsBase.assign

markAsDirty

markAsDirty(): void
Marks the settings as dirty and invokes the onDirty event handler.

Returns void
Note
This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Inherited from UserProjectSettingsBase.markAsDirty

Events

`Readonly`onDirty

onDirty: Event<[SceneWindowSettings], void>

Invoked when the settings changed.

Warning

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.