Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGumballParameterApi

Hierarchy

Index

Properties

Methods

Properties

hidden

hidden: boolean

id

id: string

interactionType

interactionType: InteractionParameterSettingsType

name

name: string

sessionValue

sessionValue: string

The value that corresponds to the latest successful call to ISessionApi.customize. This property will be updated immediately before ISessionApi.customize returns.

type

type: PARAMETER_TYPE

value

value: string

The current value.

Validation happens immediately when setting this property. An error will be thrown in case validation fails. Use isValid to test whether a value passes validation.

In case ISessionApi.automaticSceneUpdate is true, setting the value will immediately trigger a customization (see ISessionApi.customize).

Optional choices

choices?: string[]

Optional decimalplaces

decimalplaces?: number

Optional defval

defval?: string

Optional deselectOnEmpty

deselectOnEmpty?: boolean

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

Optional displayname

displayname?: string

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 expression

expression?: string

Optional format

format?: string[]

Optional group

group?: ResParameterGroup

Optional hint

hint?: string

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 interval

interval?: number

Optional max

max?: number

Optional maximumSelection

maximumSelection?: number

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

Optional min

min?: number

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 order

order?: number

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 settings

settings?: object

Optional space

space?: "local" | "world"

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

Optional structure

structure?: ResStructureType

Optional tooltip

tooltip?: string

Optional umax

umax?: number

Optional umin

umin?: number

Optional visualization

visualization?: PARAMETER_VISUALIZATION

Optional vmax

vmax?: number

Optional vmin

vmin?: number

Methods

isValid

  • isValid(value: unknown, throwError?: boolean): boolean

  • Evaluates if a given value is valid for this parameter.

    Parameters

    • value: unknown

      the value to evaluate

    • Optional throwError: boolean

      if true, an error is thrown if validation does not pass (default: false)

    Returns boolean

resetToDefaultValue

  • resetToDefaultValue(): void

  • Resets the value to the default value.

    Returns void

resetToSessionValue

  • resetToSessionValue(): void

  • Resets the value to sessionValue.

    Returns void

stringify

  • stringify(value?: unknown): string

  • Returns the current value as a string, or attempts to stringify a given value if provided.

    Parameters

    • Optional value: unknown

      the value to stringify

    Returns string