Class UICurveEditorSnapSettings

The UICurveEditorSnapSettings class provides user specific snap settings for the UICurveEditor element.

The shared instance is used to get or modify the current settings. Once the settings have been changed, a call to persist will persist any changes to the LocalOnlyEditorSettings.

Hierarchy (view full)

Constructors

constructor

Properties

timeIncrement timeMode valueIncrement valueMode

Accessors

isGlobal

Methods

assign markAsDirty

Events

onDirty

Constructors

constructor

Properties

timeIncrement

timeIncrement: number

The time snap increment.

timeMode

timeMode: EnumValue<UICurveEditorSnapMode, number>

The time snap mode.

valueIncrement

valueIncrement: number

The value snap increment.

valueMode

valueMode: EnumValue<UICurveEditorSnapMode, number>

The value snap mode.

Accessors

isGlobal

  • get isGlobal(): boolean

  • Determines if the settings instance is the global settings that require saving to the UserProjectSettings.

    Returns boolean

Methods

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.

Events

ReadonlyonDirty

onDirty: Event<[UICurveEditorSnapSettings], void>

Invoked when the settings changed.

Warning

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events