Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGumballParameterApi

Hierarchy

Index

Properties

hidden: boolean
id: string
name: string
sessionValue: string

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

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

choices?: string[]
decimalplaces?: number
defval?: string
displayname?: string
enableRotation?: boolean

If the rotation is enabled. (default: true)

enableRotationAxes?: { x?: boolean; y?: boolean; z?: boolean }

If the rotation per axis is enabled.

Type declaration

  • Optional x?: boolean
  • Optional y?: boolean
  • Optional z?: boolean
enableScaling?: boolean

If the scaling is enabled. (default: false)

enableScalingAxes?: { x?: boolean; y?: boolean; z?: boolean }

If the scaling per axis is enabled.

Type declaration

  • Optional x?: boolean
  • Optional y?: boolean
  • Optional z?: boolean
enableTranslation?: boolean

If the translation is enabled. (default: true)

enableTranslationAxes?: { x?: boolean; y?: boolean; z?: boolean }

If the translation per axis is enabled.

Type declaration

  • Optional x?: boolean
  • Optional y?: boolean
  • Optional z?: boolean
expression?: string
format?: string[]
group?: ResParameterGroup
hint?: string
hover?: boolean

If the objects are hoverable. (default: true)

hoverColor?: string

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

interval?: number
max?: number
min?: number
nameFilter?: string[]

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

order?: number
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.

scale?: number

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

selectionColor?: string

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

settings?: object
space?: "local" | "world"

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

structure?: ResStructureType
tooltip?: string
umax?: number
umin?: number
visualization?: PARAMETER_VISUALIZATION
vmax?: number
vmin?: number

Methods

  • 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(): void
  • Resets the value to the default value.

    Returns void

  • resetToSessionValue(): void
  • Resets the value to sessionValue.

    Returns void

  • 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