@siedlerchr/types-ol-ext/geom/Dijkstra.d.ts

Type definitions for ol-ext

import type { Coordinate } from 'ol/coordinate'
import type Feature from 'ol/Feature'
import type { Geometry, LineString } from 'ol/geom'
import type { ObjectEvent } from 'ol/Object'
import ol_Object from 'ol/Object'
import type VectorSource from 'ol/source/Vector'
import BaseEvent from 'ol/events/Event'
import type { CombinedOnSignature, EventTypes, OnSignature } from 'ol/Observable'
import type { EventsKey } from 'ol/events'
import type { Types } from 'ol/ObjectEventType'

export interface Options {
  source: VectorSource;
  maxIteration?: number;
  stepIteration?: number;
  epsilon?: number;
}

type DijkstraOnSignature<Return> = OnSignature<EventTypes, Event, Return> &
  OnSignature<Types | 'change' | 'change:active' | 'error' | 'propertychange', ObjectEvent, Return> &
  OnSignature<Types | 'finish', DijkstraFinishEvent, Return> &
  OnSignature<Types | 'pause', DijkstraPauseEvent, Return> &
  OnSignature<Types | 'start' | 'calculating', BaseEvent, Return> &
  CombinedOnSignature<Types | EventTypes, Return>;

/**
 * @classdesc
 * Compute the shortest paths between nodes in a graph source
 * The source must only contains LinesString.
 *
 * It uses a A* optimisation.
 * You can overwrite methods to customize the result.
 * @see https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm
 * @constructor
 * @fires calculating
 * @fires start
 * @fires finish
 * @fires pause

 */
export default class Dijskra extends ol_Object {
  /**
   * @param {any} options
   *  @param {VectorSource} options.source the source for the edges
   *  @param {number} [options.maxIteration=20000] maximum iterations before a pause event is fired, default 20000
   *  @param {number} [options.stepIteration=2000] number of iterations before a calculating event is fired, default 2000
   *  @param {number} [options.epsilon=1E-6] geometric precision (min distance beetween 2 points), default 1E-6
   */
  constructor(options?: Options);

  /** Get the weighting of the edge, for example a speed factor
   * The function returns a value beetween ]0,1]
   * - 1   = no weighting
   * - 0.5 = goes twice more faster on this road
   *
   * If no feature is provided you must return the lower weighting you're using
   * @param {Feature} feature
   * @return {number} a number beetween 0-1
   * @api
   */
  weight(feature?: Feature): number;

  /** Get the edge direction
   * -  0 : the road is blocked
   * -  1 : direct way
   * - -1 : revers way
   * -  2 : both way
   * @param {Feature} feature
   * @return {Number} 0: blocked, 1: direct way, -1: revers way, 2:both way
   * @api
   */
  direction(feature: Feature): number;

  /** Calculate the length of an edge
   * @param {Feature|LineString} geom
   * @return {number}
   * @api
   */
  getLength(geom: Feature | LineString): number;

  /** Get the nodes source concerned in the calculation
   * @return {VectorSource}
   */
  getNodeSource(): VectorSource;

  /** Get all features at a coordinate
   * @param {Coordinate} coord
   * @return {Array<Feature>}
   */
  getEdges(coord: Coordinate): Feature[];

  /** Get a node at a coordinate
   * @param {Coordinate} coord
   * @return {Feature} the node
   */
  getNode(coord: Coordinate): Feature;

  /** Calculate a path beetween 2 points
   * @param {Coordinate} start
   * @param {Coordinate} end
   * @return {boolean|Array<Coordinate>} false if don't start (still running) or start and end nodes
   */
  path(start: Coordinate, end: Coordinate): boolean | Coordinate[];

  /** Restart after pause
   */
  resume(): void;

  /** Pause
   */
  pause(): void;

  /** Get the current 'best way'.
   * This may be used to animate while calculating.
   * @return {Array<Feature>}
   */
  getBestWay(): Feature[];

  on: DijkstraOnSignature<EventsKey>

  once: DijkstraOnSignature<EventsKey>

  un: DijkstraOnSignature<void>
}

export class DijkstraFinishEvent extends BaseEvent {
  constructor(type: 'finish',
              route: Feature<Geometry>[],
              wDistance: number,
              distance: number
  )

  route: Feature<Geometry>[]

  wDistance: number

  distance: number
}

export class DijkstraPauseEvent extends BaseEvent {
  constructor(type: 'pause',
              overflow: boolean
  )

  overflow: boolean
}