Class NavigationVolumeInteractiveGizmo

The NavigationVolumeInteractiveGizmo draws the navigation mesh and handles for the selected NavigationVolume.

Hierarchy (view full)

InteractiveGizmo
- NavigationVolumeInteractiveGizmo

Index

Constructors

Properties

navigationData navigationMesh visualizedPath volume

Accessors

Methods

destroy draw drawSliderGizmos postInput preInput

Constructors

constructor

new NavigationVolumeInteractiveGizmo(volume): NavigationVolumeInteractiveGizmo
Parameters
- volume: NavigationVolume
Returns NavigationVolumeInteractiveGizmo
Overrides InteractiveGizmo.constructor

Properties

navigationData

navigationData: NavigationData

The active navigation data.

navigationMesh

navigationMesh: MeshData

The active navigation mesh.

visualizedPath

visualizedPath: Immutable<Vector3>[]

The path to be visualized, in order start to end. Should contain at least one element.

`Readonly`volume

volume: NavigationVolume

The current volume.

Accessors

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

Methods

destroy

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

Returns void
Inherited from InteractiveGizmo.destroy

`Abstract`draw

draw(event): void
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 void
Overrides InteractiveGizmo.draw

drawSliderGizmos

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

`Abstract`postInput

postInput(event): void
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 void
Overrides InteractiveGizmo.postInput

`Abstract`preInput

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