Class NavigationGraphController

Owns the active NavigationGraph and drives its editing: creating and moving nodes and edges, tracking selection, validating geometry, and committing, reverting, or snapshotting the graph.

Constructors

constructor

new NavigationGraphController(viewer: Viewer): NavigationGraphController
Parameters
- viewer: Viewer
Returns NavigationGraphController
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:79

Properties

`Readonly`signals

signals: {
    onEditingChanged: ViewerSignal<(editing: boolean) => void>;
    onGraphChanged: ViewerSignal<(change?: NavigationGraphChange) => void>;
    onSelectionChanged: ViewerSignal<
        (change: NavigationSelectionChange) => void,
    >;
} = ...

`Readonly`validator

validator: NavigationGraphValidator

Accessors

activeGraph

get activeGraph(): NavigationGraph | null
Returns NavigationGraph | null
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:83

isEditing

get isEditing(): boolean
Returns boolean
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:91

selectedElements

get selectedElements(): Readonly<NavigationSelection>
Returns Readonly<NavigationSelection>
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:87

Methods

addEdge

addEdge(
    from: string,
    to: string,
    options?: CreateNavigationEdgeOptions,
): NavigationEdge
Parameters
- from: string
- to: string
- Optionaloptions: CreateNavigationEdgeOptions
Returns NavigationEdge
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:210

addNode

addNode(
position: Vector3,
options?: CreateNavigationNodeOptions,
): NavigationNode
Parameters
- position: Vector3
- Optionaloptions: CreateNavigationNodeOptions
Returns NavigationNode
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:170

clear

clear(): void
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:127

commit

commit(): void
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:280

createGraph

createGraph(id?: string): NavigationGraph
Parameters
- Optionalid: string
Returns NavigationGraph
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:95

deleteConnectedComponent

deleteConnectedComponent(elementId: string): void
Parameters
- elementId: string
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:225

deleteEdge

deleteEdge(id: string): void
Parameters
- id: string
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:219

deleteNode

deleteNode(id: string): void
Parameters
- id: string
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:202

exportGraph

exportGraph(): SerializedNavigationGraph
Returns SerializedNavigationGraph
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:111

importGraph

importGraph(value: unknown): NavigationGraph
Parameters
- value: unknown
Returns NavigationGraph
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:102

mergeNodes

mergeNodes(
ids: readonly string[],
position: NavigationMergePosition,
): NavigationNode
Parameters
- ids: readonly string[]
- position: NavigationMergePosition
Returns NavigationNode
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:234

moveNode

moveNode(id: string, position: Vector3, validateGeometry?: boolean): void
Parameters
- id: string
- position: Vector3
- validateGeometry: boolean = true
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:178

restore

restore(snapshot: NavigationGraph): void
Parameters
- snapshot: NavigationGraph
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:311

reverseEdge

reverseEdge(id: string): void
Parameters
- id: string
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:268

revert

revert(): void
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:290

selectEdges

selectEdges(ids: readonly string[]): void
Parameters
- ids: readonly string[]
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:162

selectNodes

selectNodes(ids: readonly string[]): void
Parameters
- ids: readonly string[]
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:154

setEdgeAccessible

setEdgeAccessible(id: string, accessible: boolean): void
Parameters
- id: string
- accessible: boolean
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:258

setEdgeDirection

setEdgeDirection(id: string, direction: "forward" | "both"): void
Parameters
- id: string
- direction: "forward" | "both"
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:263

setEditing

setEditing(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:141

setGraph

setGraph(graph: NavigationGraph, markAsSaved?: boolean): void
Parameters
- graph: NavigationGraph
- markAsSaved: boolean = false
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:117

setNodeAccessible

setNodeAccessible(id: string, accessible: boolean): void
Parameters
- id: string
- accessible: boolean
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:253

snapshot

snapshot(): NavigationGraph
Returns NavigationGraph
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:307

validate

validate(): NavigationGraphValidationError[]
Returns NavigationGraphValidationError[]
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:273

validateNodeGeometry

validateNodeGeometry(id: string): void
Parameters
- id: string
Returns void
- Defined in plugins/src/PathPlugin/navigation/NavigationGraphController.ts:191