Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGumballParameterProps

Properties of a selection parameter.

Hierarchy

Index

Properties

Properties

Optional deselectOnEmpty

deselectOnEmpty?: boolean

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

Optional enableRotation

enableRotation?: boolean

If the rotation is enabled. (default: true)

Optional enableRotationAxes

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

If the rotation per axis is enabled.

Type declaration

  • Optional x?: boolean
  • Optional xy?: boolean
  • Optional xz?: boolean
  • Optional y?: boolean
  • Optional yz?: boolean
  • Optional z?: boolean

Optional enableScaling

enableScaling?: boolean

If the scaling is enabled. (default: false)

Optional enableScalingAxes

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

If the scaling per axis is enabled.

Type declaration

  • Optional x?: boolean
  • Optional xy?: boolean
  • Optional xz?: boolean
  • Optional y?: boolean
  • Optional yz?: boolean
  • Optional z?: boolean

Optional enableTranslation

enableTranslation?: boolean

If the translation is enabled. (default: true)

Optional enableTranslationAxes

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

If the translation per axis is enabled.

Type declaration

  • Optional x?: boolean
  • Optional xy?: boolean
  • Optional xz?: boolean
  • Optional y?: boolean
  • Optional yz?: boolean
  • Optional z?: boolean

Optional hover

hover?: boolean

If the objects are hoverable. (default: true)

Optional hoverColor

hoverColor?: string

The color of the objects when hovered. (default: '#00ff78')

Optional maximumSelection

maximumSelection?: number

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

Optional minimumSelection

minimumSelection?: number

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

Optional nameFilter

nameFilter?: string[]

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

Optional objects

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!

Optional prompt

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

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

Type declaration

  • Optional activeText?: string

    The text when the parameter is inactive.

  • Optional activeTitle?: string

    The title when the parameter is active.

  • Optional inactiveTitle?: string

    The title when the parameter is inactive.

Optional restrictions

restrictions?: RestrictionDefinition[]

The restrictions that can be applied to the draggable objects.

Optional scale

scale?: number

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

Optional selectionColor

selectionColor?: string

The color of the objects when selected. (default: '#0d44f0')

Optional space

space?: "local" | "world"

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