Class BuiltInInteractiveGizmo`Abstract`

The BuiltInInteractiveGizmo implements an abstract base class for all the built-in InteractiveGizmo types.

Hierarchy (view full)

InteractiveGizmo
- BuiltInInteractiveGizmo

Index

Constructors

Properties

_isDragActive _position _rotation

Accessors

delta isDragging isEnabled isHovering worldPosition worldRotation

Methods

destroy draw drawSliderGizmos getSliderGizmoColor postInput preInput

Events

onDragStart onDrag onDragFinished

Constructors

constructor

new BuiltInInteractiveGizmo(): BuiltInInteractiveGizmo
Returns BuiltInInteractiveGizmo
Overrides InteractiveGizmo.constructor

Properties

`Protected`_isDragActive

_isDragActive: boolean

`Protected` `Readonly`_position

_position: Vector3

`Protected` `Readonly`_rotation

_rotation: Quaternion

Accessors

`Abstract`delta

get delta(): any
The delta of the current drag operation.

Returns any

`Abstract`isDragging

get isDragging(): boolean
Determines if the gizmo currently being interacted with (clicking, or dragging).

Returns boolean

isEnabled

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

Returns boolean
Inherited from InteractiveGizmo.isEnabled

`Abstract`isHovering

get isHovering(): boolean
Determines if the gizmo currently being hovered.

Returns boolean

worldPosition

get worldPosition(): Vector3
World position of the gizmo.

Returns Vector3
set worldPosition(value): void
Parameters
- value: Immutable<Vector3>
Returns void

worldRotation

get worldRotation(): Quaternion
World rotation of the gizmo.

Returns Quaternion
set worldRotation(value): void
Parameters
- value: Immutable<Quaternion>
Returns void

Methods

destroy

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

Returns void
Inherited from InteractiveGizmo.destroy

`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
Inherited from InteractiveGizmo.draw

drawSliderGizmos

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

getSliderGizmoColor

getSliderGizmoColor(gizmo, color, isHoveringAnyGizmo): Color
Selects the right color for the gizmo, if another gizmo is hovered the gizmo will be grayed out.
Parameters
- gizmo: InteractiveGizmoSliderBase
- color: Color
- isHoveringAnyGizmo: boolean
Returns Color

postInput

postInput(event): void
Virtual
Called every frame after handle input is processed. Active handle sliders should contain values signals if and how much they were dragged.
Parameters
- event: InteractiveGizmoEvent
Returns void
Note
Implementing classes must call super

Overrides InteractiveGizmo.postInput

`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
Inherited from InteractiveGizmo.preInput

Events

`Readonly`onDragStart

onDragStart: Event<any[], void>

Invoked when a drag is started and a new delta is available.

Note

The onDrag event is invoked right after this event. Do not integrate the current delta during this event.

`Readonly`onDrag

onDrag: Event<any[], void>

Invoked when a drag is performed and a new delta is available.

`Readonly`onDragFinished

onDragFinished: Event<any[], void>

Invoked when the drag finished.