Class SnappingSettings

The SnappingSettings class contains settings for snapping in the viewport.

Hierarchy (view full)

UserProjectSettingsBase<SnappingSettings>
- SnappingSettings

Index

Constructors

Properties

gridSnapping sceneSnapping

Accessors

Methods

assign markAsDirty

Events

Constructors

constructor

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

Properties

gridSnapping

gridSnapping: GridSnappingSettings

sceneSnapping

sceneSnapping: SceneSnappingSettings

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<SnappingSettings>
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<[SnappingSettings], void>

Invoked when the settings changed.

Warning

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