Viewer
    Preparing search index...

    Interface IGumballTransformParameterProps

    Properties of a selection parameter.

    interface IGumballTransformParameterProps {
        activeMode?: "default" | "activeOnStart";
        availableColor?: InteractionEffect;
        deselectOnEmpty?: boolean;
        enableRotation?: boolean;
        enableRotationAxes?: {
            x?: boolean;
            xy?: boolean;
            xz?: boolean;
            y?: boolean;
            yz?: boolean;
            z?: boolean;
        };
        enableScaling?: boolean;
        enableScalingAxes?: {
            x?: boolean;
            xy?: boolean;
            xz?: boolean;
            y?: boolean;
            yz?: boolean;
            z?: boolean;
        };
        enableTranslation?: boolean;
        enableTranslationAxes?: {
            x?: boolean;
            xy?: boolean;
            xz?: boolean;
            y?: boolean;
            yz?: boolean;
            z?: boolean;
        };
        hover?: boolean;
        hoverColor?: InteractionEffect;
        maximumSelection?: number;
        minimumSelection?: number;
        nameFilter?: string[];
        objects?: IDraggableObject[];
        prompt?: {
            activeText?: string;
            activeTitle?: string;
            inactiveTitle?: string;
        };
        restrictions?: RestrictionDefinition[];
        scale?: number;
        selectionColor?: InteractionEffect;
        space?: "local"
        | "world";
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeMode? availableColor? deselectOnEmpty? enableRotation? enableRotationAxes? enableScaling? enableScalingAxes? enableTranslation? enableTranslationAxes? hover? hoverColor? maximumSelection? minimumSelection? nameFilter? objects? prompt? restrictions? scale? selectionColor? space?

    Properties

    activeMode?: "default" | "activeOnStart"

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

    availableColor?: InteractionEffect

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

    deselectOnEmpty?: boolean

    If true, the selection will be cleared when clicking on an empty space. (default: false)

    enableRotation?: boolean

    If the rotation is enabled. (default: true)

    enableRotationAxes?: {
        x?: boolean;
        xy?: boolean;
        xz?: boolean;
        y?: boolean;
        yz?: boolean;
        z?: boolean;
    }

    If the rotation per axis is enabled.

    enableScaling?: boolean

    If the scaling is enabled. (default: false)

    enableScalingAxes?: {
        x?: boolean;
        xy?: boolean;
        xz?: boolean;
        y?: boolean;
        yz?: boolean;
        z?: boolean;
    }

    If the scaling per axis is enabled.

    enableTranslation?: boolean

    If the translation is enabled. (default: true)

    enableTranslationAxes?: {
        x?: boolean;
        xy?: boolean;
        xz?: boolean;
        y?: boolean;
        yz?: boolean;
        z?: boolean;
    }

    If the translation per axis is enabled.

    hover?: boolean

    If the objects are hoverable. (default: true)

    hoverColor?: InteractionEffect

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

    maximumSelection?: number

    The maximum number of objects that can be selected. (default: 1)

    minimumSelection?: number

    The minimum number of objects that can be selected. (default: 1)

    nameFilter?: string[]

    The names of the objects that can be interacted with. (see Jira document and discussion result)

    objects?: IDraggableObject[]

    The objects that can be dragged.

    For each object, the name filter and the restrictions 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.

    This is only used for dragging, not for rotation or scaling!

    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[]

    The restrictions that can be applied to the draggable objects.

    scale?: number

    The scale of the controls. The scale divides the scene bounding sphere to get the actual size. (default: 0.005)

    selectionColor?: InteractionEffect

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

    space?: "local" | "world"

    The space in which the controls operate. In world space, scaling is not available. (default: 'local')

    Settings

    Member Visibility

    On This Page

    Properties