Class NavigationGraph

constructor

• new NavigationGraph(id?: string): NavigationGraph

  Parameters

  • id: string = ...

  Returns NavigationGraph

Readonlyedges

Readonlyid

Readonlynodes

Static ReadonlyformatVersion

addEdge

• addEdge(
      fromNodeId: string,
      toNodeId: string,
      options?: CreateNavigationEdgeOptions,
  ): NavigationEdge

  Parameters

  • fromNodeId: string
  • toNodeId: string
  • options: CreateNavigationEdgeOptions = {}

  Returns NavigationEdge

addNode

• addNode(
      position: Vector3,
      options?: CreateNavigationNodeOptions,
  ): NavigationNode

  Parameters

  • position: Vector3
  • options: CreateNavigationNodeOptions = {}

  Returns NavigationNode

clone

• clone(): NavigationGraph

  Returns NavigationGraph

deleteConnectedComponent

• deleteConnectedComponent(elementId: string): Set<string>

  Parameters

  • elementId: string

  Returns Set<string>

deleteEdge

• deleteEdge(edgeId: string): NavigationEdge

  Parameters

  • edgeId: string

  Returns NavigationEdge

deleteNode

• deleteNode(nodeId: string): NavigationNode

  Parameters

  • nodeId: string

  Returns NavigationNode

findEdge

• findEdge(firstNodeId: string, secondNodeId: string): NavigationEdge | undefined

  Parameters

  • firstNodeId: string
  • secondNodeId: string

  Returns NavigationEdge | undefined

getConnectedNodeIds

• getConnectedNodeIds(elementId: string): Set<string>

  Parameters

  • elementId: string

  Returns Set<string>

mergeNodes

• mergeNodes(
      nodeIds: readonly string[],
      positionMode: NavigationMergePosition,
  ): NavigationNode

  Parameters

  • nodeIds: readonly string[]
  • positionMode: NavigationMergePosition

  Returns NavigationNode

moveNode

• moveNode(nodeId: string, position: Vector3, positionValid?: boolean): void

  Parameters

  • nodeId: string
  • position: Vector3
  • positionValid: boolean = true

  Returns void

requireEdge

• requireEdge(edgeId: string): NavigationEdge

  Parameters

  • edgeId: string

  Returns NavigationEdge

requireNode

• requireNode(nodeId: string): NavigationNode

  Parameters

  • nodeId: string

  Returns NavigationNode

reverseEdge

• reverseEdge(edgeId: string): void

  Parameters

  • edgeId: string

  Returns void

validate

• validate(): NavigationGraphValidationError[]

  Collects structural errors and errors derived from the current geometry validity states.

  Returns NavigationGraphValidationError[]