Viewer
    Preparing search index...

    Interface IDraggingParameterProps

    Properties of a dragging parameter.

    interface IDraggingParameterProps {
        activeMode?: "default" | "activeOnStart" | "alwaysActive";
        automaticSceneUpdate?: boolean;
        automaticSceneUpdateTimeout?: number;
        availableColor?: InteractionEffect;
        buttons?: { clear?: boolean };
        draggingColor?: InteractionEffect;
        hover?: boolean;
        hoverColor?: InteractionEffect;
        objects?: IDraggableObject[];
        occludeBySceneGeometry?: boolean;
        presentation?: "widget" | "toolbar";
        prompt?: {
            activeText?: string;
            activeTitle?: string;
            inactiveTitle?: string;
        };
        restrictions?: RestrictionDefinition[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeMode? automaticSceneUpdate? automaticSceneUpdateTimeout? availableColor? buttons? draggingColor? hover? hoverColor? objects? occludeBySceneGeometry? presentation? prompt? restrictions?

    Properties

    activeMode?: "default" | "activeOnStart" | "alwaysActive"

    The mode to determine when the parameter is active. (default: 'default')

    automaticSceneUpdate?: boolean

    If true, a customization is requested after handles stop changing. Waits automaticSceneUpdateTimeout after the last committed change.

    This is not session-level ISessionApi.automaticSceneUpdate, which controls whether the session scene tree node is replaced after customize.

    Used by gumball, rectangle transform, and dragging. Selection ignores it.

    false
    automaticSceneUpdateTimeout?: number

    Idle timeout in milliseconds before automaticSceneUpdate requests a customization. Reset on each committed handle move.

    1000
    availableColor?: InteractionEffect

    The interaction effect on objects when available. (default: '#ffffff')

    buttons?: { clear?: boolean }

    Which buttons are available for the interaction parameter.

    Type Declaration

    • Optionalclear?: boolean

      When true, the clear button is available to reset the parameter. (default: true)

    draggingColor?: InteractionEffect

    The interaction effect on objects when dragged. (default: '#0d44f0')

    hover?: boolean

    If the objects are hoverable. (default: true)

    hoverColor?: InteractionEffect

    The interaction effect on objects when hovered. (default: '#00ff78')

    objects?: IDraggableObject[]

    The objects that can be dragged.

    For each object, the name filter, the restrictions, the drag anchors, and the drag origin can be defined. The name filter is used to filter the objects that can be dragged with the defined settings. This means that multiple objects can be dragged with different settings, but also multiple objects can be dragged with the same settings.

    occludeBySceneGeometry?: boolean

    When true, interactions are blocked by non-interactive solid geometry in front of the target. (default: false)

    presentation?: "widget" | "toolbar"

    The presentation of the interaction parameter. (default: 'toolbar')

    prompt?: { activeText?: string; activeTitle?: string; inactiveTitle?: string }

    A prompt that can be defined which is displayed instead of the default prompt.

    Type Declaration

    • OptionalactiveText?: string

      The text when the parameter is inactive.

    • OptionalactiveTitle?: string

      The title when the parameter is active.

    • OptionalinactiveTitle?: string

      The title when the parameter is inactive.

    restrictions?: RestrictionDefinition[]

    Settings

    Member Visibility

    On This Page

    Properties