RSX Code Reference
    Preparing search index...

    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 Summary)

    Index
    constructor
    timeIncrement timeMode valueIncrement valueMode
    isGlobal
    assign markAsDirty
    onDirty
    timeIncrement: number

    The time snap increment.

    timeMode: EnumValue<UICurveEditorSnapMode>

    The time snap mode.

    valueIncrement: number

    The value snap increment.

    valueMode: EnumValue<UICurveEditorSnapMode>

    The value snap mode.

    • get isGlobal(): boolean

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

      Returns boolean

    • Copies all properties defined by the prototype of other to this instance.

      Parameters

      • other: Readonly<T>

      Returns void

    • Marks the settings as dirty and invokes the onDirty event handler.

      Returns void

      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.

    onDirty: Event<[UICurveEditorSnapSettings], void>

    Invoked when the settings changed.

    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