Interface ISceneSetDirtyOptions

interface ISceneSetDirtyOptions {
    bubbleToParent?: boolean;
    change?: string;
    fadeDuration?: number;
    frameFade?: boolean;
    geometryChanged?: boolean;
    key?: string;
    last?: boolean;
    refreshScene?: boolean;
    refreshUi?: boolean;
    sceneUpdate?: boolean;
    source?: string;
    uiChangeEvent?: ChangeEvent;
    undo?: boolean;
    updateGround?: boolean;
}

Hierarchy (View Summary)

Properties

bubbleToParent? change? fadeDuration? frameFade? geometryChanged? key? last? refreshScene? refreshUi? sceneUpdate? source? uiChangeEvent? undo? updateGround?

Properties

OptionalbubbleToParent

bubbleToParent?: boolean

Optionalchange

change?: string

OptionalfadeDuration

fadeDuration?: number

Duration for frameFade in ms. Check FrameFadePlugin for more details.

OptionalframeFade

frameFade?: boolean

Enable/disable frame fade using FrameFadePlugin Default true. when the plugin is enabled and has corresponding flags enabled

OptionalgeometryChanged

geometryChanged?: boolean

Optionalkey

key?: string

Optionallast

last?: boolean

Set to true if this is the last value in a user input chain. (like when mouse up on slider)

OptionalrefreshScene

refreshScene?: boolean

OptionalrefreshUi

refreshUi?: boolean

Trigger UI Config Refresh along with setDirty. Default true. Set to false to prevent UI Config refresh.

OptionalsceneUpdate

sceneUpdate?: boolean

Deprecated

use refreshScene instead

Optionalsource

source?: string

OptionaluiChangeEvent

uiChangeEvent?: ChangeEvent

Event from uiconfig.js when some value changes from the UI.

Optionalundo

undo?: boolean

Indicates that this change in from an undo operation.

OptionalupdateGround

updateGround?: boolean

Settings

Member Visibility

On This Page

Properties