Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGumballParameterProps

Properties of a selection parameter.

Hierarchy

Index

Properties

Properties

Optional enableRotation

enableRotation?: boolean

If the rotation is enabled. (default: true)

Optional enableRotationAxes

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

Optional enableScaling

enableScaling?: boolean

If the scaling is enabled. (default: false)

Optional enableScalingAxes

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

Optional enableTranslation

enableTranslation?: boolean

If the translation is enabled. (default: true)

Optional enableTranslationAxes

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

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 nameFilter

nameFilter?: string[]

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

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