Class Navigation`Abstract`

The Navigation interface provides different APIs to perform scene navigation utilties that can be used to perform tasks such as path finding and actor movement.

Index

Constructors

Accessors

isAvailable processorName

Methods

createQuery generateNavigationData generateVisualizationMesh

Constructors

constructor

new Navigation(): Navigation

Returns Navigation

Accessors

`Static`isAvailable

get isAvailable(): boolean

Determines if a mesh processor is available.

Returns boolean

`Static`processorName

get processorName(): string

Gets the name of the processor.

Returns string

Methods

`Static`createQuery

createQuery(
scene: SceneInstance,
navigationData: NavigationData,
): NavigationQuery
Creates a query for the specified SceneInstace.
Parameters
- scene: SceneInstance
- navigationData: NavigationData
Returns NavigationQuery

`Static`generateNavigationData

generateNavigationData(
scene: SceneInstance,
settings: NavigationSettings,
): UncertainAsyncOp<NavigationDataResult, string>
Calculates the navigation data for the specified scene using the settings.
Parameters
- scene: SceneInstance
- settings: NavigationSettings
Returns UncertainAsyncOp<NavigationDataResult, string>

`Static`generateVisualizationMesh

generateVisualizationMesh(navigationData: NavigationData): MeshData
Generates a visualization mesh for the precalculated navigationData.
Parameters
- navigationData: NavigationData
Returns MeshData