Class InteractiveGizmo`Abstract`

The InteractiveGizmo class is the base-class for an interactive gizmo that will handle input and draw some representation. InteractiveGizmos provide that ability to manipulate the gizmo using sliders that are registered with the gizmo.

Hierarchy (view full)

FrameworkObject
- InteractiveGizmo

Index

Constructors

Accessors

Methods

destroy draw drawSliderGizmos postInput preInput

Constructors

constructor

new InteractiveGizmo(isInternalConstructor?): InteractiveGizmo
Parameters
- OptionalisInternalConstructor: boolean
Returns InteractiveGizmo
Overrides FrameworkObject.constructor

Accessors

isEnabled

get isEnabled(): boolean
Determines the active state of the gizmo. If disabled, the gizmo will not render or receive input.

Returns boolean

Methods

destroy

destroy(): void
Destroy the interactive gizmo and registered slider gizmos.

Returns void

`Abstract`draw

draw(event): any
Virtual
Called every frame after postInput. Allows interactive gizmo graphics to be drawn. This is the only method that draw methods may be called
Parameters
- event: InteractiveGizmoEvent
Returns any

drawSliderGizmos

drawSliderGizmos(event): void
Draws all child slider gizmos registered to this gizmo.
Parameters
- event: InteractiveGizmoEvent
Returns void

`Abstract`postInput

postInput(event): any
Virtual
Called every frame after interactive gizmo input is processed. Active interactive gizmos will now contain values and signals if and how much they were dragged.
Parameters
- event: InteractiveGizmoEvent
Returns any

`Abstract`preInput

preInput(event): any
Virtual
Called every frame before interactive gizmo input is processed. Allows interactive gizmo transforms to be updated before input.
Parameters
- event: InteractiveGizmoEvent
Returns any