ThreePipe
    Preparing search index...

    Interface ISceneSetDirtyOptions

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    bubbleToParent?: boolean

    Bubble event to parent root(scene).

    change?: string

    Change identifier that triggered the setDirty call. This is different from key in that it is used to identify the property/key that is changed. In many cases these could be same, but they could also be different eg, key might be x, with change being position.

    fadeDuration?: number

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

    frameFade?: boolean

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

    geometryChanged?: boolean

    Indicate whether the geometry has been changed to properly refresh plugins like ground, shadows.

    key?: string

    Key to identify the change. This is used to identify the change in the event. Can be used interchangeably with change. Set from onChange3 etc.

    last?: boolean

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

    oldValue?: any

    Old value before the change. Set from onChange3 etc.

    refreshScene?: boolean

    Update scene(bounds, shadows, plugins, etc) after setting dirty.

    refreshUi?: boolean

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

    sceneUpdate?: boolean

    update scene after setting dirty

    use refreshScene instead

    source?: string

    Source identifier of who is triggering the event. so that recursive events can be prevented

    uiChangeEvent?: ChangeEvent

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

    undo?: boolean

    Indicates that this change in from an undo operation.

    updateGround?: boolean
    value?: any

    New value that triggered the change. Set from onChange3 etc.

    Settings

    Member Visibility

    On This Page

    Properties