Viewer
    Preparing search index...

    Interface IInteractionParameterProps

    General properties of an interaction parameter.

    interface IInteractionParameterProps {
        activeMode?: "default" | "activeOnStart" | "alwaysActive";
        automaticSceneUpdate?: boolean;
        automaticSceneUpdateTimeout?: number;
        buttons?: { clear?: boolean };
        hover?: boolean;
        hoverColor?: InteractionEffect;
        occludeBySceneGeometry?: boolean;
        presentation?: "widget" | "toolbar";
        prompt?: {
            activeText?: string;
            activeTitle?: string;
            inactiveTitle?: string;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeMode? automaticSceneUpdate? automaticSceneUpdateTimeout? buttons? hover? hoverColor? occludeBySceneGeometry? presentation? prompt?

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

    hover?: boolean

    If the objects are hoverable. (default: true)

    hoverColor?: InteractionEffect

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

    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.

    Settings

    Member Visibility

    On This Page

    Properties