terriajs/lib/Models/Definition/StratumOrder.ts

Geospatial data visualization platform.

import { ObservableMap } from "mobx";
import DeveloperError from "terriajs-cesium/Source/Core/DeveloperError";
import CommonStrata from "./CommonStrata";

const million = 1000000;

/**
 * Defines the relative ordering of strata.
 */
export default class StratumOrder {
  /**
   * The priorities of each named stratum. Strata with higher priority values are "above" and override
   * strata with lower priority values.
   */
  readonly priorities = new ObservableMap<string, number>();

  /**
   * The next priority to assign to a default stratum.
   */
  nextDefault: number = 1 * million;

  /**
   * The next priority to assign to a load stratum.
   */
  nextLoad: number = 2 * million;

  /**
   * The next priority to assign to a definition stratum.
   */
  nextDefinition: number = 3 * million;

  /**
   * The next priority to assign to a user stratum.
   */
  nextUser: number = 4 * million;

  constructor() {
    this.addDefaultStratum(CommonStrata.defaults);
    this.addDefinitionStratum(CommonStrata.underride);
    this.addDefinitionStratum(CommonStrata.definition);
    this.addDefinitionStratum(CommonStrata.override);
    this.addUserStratum(CommonStrata.user);
  }

  /**
   * Assigns a priority to a default stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  addDefaultStratum(id: string) {
    if (this.priorities.get(id) === undefined) {
      this.priorities.set(id, this.nextDefault);
      this.nextDefault += 10;
    }
  }

  /**
   * Assigns a priority to a load stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  addLoadStratum(id: string) {
    if (this.priorities.get(id) === undefined) {
      this.priorities.set(id, this.nextLoad);
      this.nextLoad += 10;
    }
  }

  /**
   * Assigns a priority to a definition stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  addDefinitionStratum(id: string) {
    if (this.priorities.get(id) === undefined) {
      this.priorities.set(id, this.nextDefinition);
      this.nextDefinition += 10;
    }
  }

  /**
   * Assigns a priority to a user stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  addUserStratum(id: string) {
    if (this.priorities.get(id) === undefined) {
      this.priorities.set(id, this.nextUser);
      this.nextUser += 10;
    }
  }

  /**
   * Sorts the given strata in top-to-bottom order so that strata with a higher priority value occur
   * earlier in the returned array.
   * @param strata The strata to sort.
   * @returns The strata sorted top-to-bottom.
   */
  sortTopToBottom<T>(strata: Map<string, T>): Map<string, T> {
    return this.sort(strata, (a, b) => {
      const aId = a[0];
      const bId = b[0];

      if (aId === "top" && bId === "bottom") {
        return -1;
      } else if (aId === "bottom" && bId === "top") {
        return 1;
      }

      const aPriority = this.priorities.get(aId);
      if (aPriority === undefined) {
        throw new DeveloperError(
          `Stratum ${aId} does not exist in StratumOrder.`
        );
      }
      const bPriority = this.priorities.get(bId);
      if (bPriority === undefined) {
        throw new DeveloperError(
          `Stratum ${bId} does not exist in StratumOrder.`
        );
      }

      return bPriority - aPriority;
    });
  }

  /**
   * Sorts the given strata in top-to-bottom order so that strata with a higher priority value occur
   * later in the returned array.
   * @param strata The strata to sort.
   * @returns The strata sorted bottom-to-top.
   */
  sortBottomToTop<T>(strata: Map<string, T>): Map<string, T> {
    return this.sort(strata, (a, b) => {
      const aId = a[0];
      const bId = b[0];

      if (aId === "top" && bId === "bottom") {
        return 1;
      } else if (aId === "bottom" && bId === "top") {
        return -1;
      }

      const aPriority = this.priorities.get(aId);
      if (aPriority === undefined) {
        throw new DeveloperError(
          `Stratum ${aId} does not exist in StratumOrder.`
        );
      }
      const bPriority = this.priorities.get(bId);
      if (bPriority === undefined) {
        throw new DeveloperError(
          `Stratum ${bId} does not exist in StratumOrder.`
        );
      }

      return aPriority - bPriority;
    });
  }

  private sort<T>(
    strata: Map<string, T>,
    sortFunction: (a: [string, T], b: [string, T]) => number
  ): Map<string, T> {
    return new Map(Array.from(strata.entries()).sort(sortFunction));
  }

  static readonly instance = new StratumOrder();

  /**
   * Assigns a priority to a default stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  static addDefaultStratum(id: string) {
    StratumOrder.instance.addDefaultStratum(id);
  }

  /**
   * Assigns a priority to a load stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  static addLoadStratum(id: string) {
    StratumOrder.instance.addLoadStratum(id);
  }

  /**
   * Assigns a priority to a definition stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  static addDefinitionStratum(id: string) {
    StratumOrder.instance.addDefinitionStratum(id);
  }

  /**
   * Assigns a priority to a user stratum. If the stratum already has a priority, this function does nothing.
   * @param id The ID of the stratum.
   */
  static addUserStratum(id: string) {
    StratumOrder.instance.addUserStratum(id);
  }

  /**
   * Sorts the given strata in top-to-bottom order so that strata with a higher priority value occur
   * earlier in the returned array.
   * @param strata The strata to sort.
   * @returns The strata sorted top-to-bottom.
   */
  static sortTopToBottom<T>(strata: Map<string, T>): Map<string, T> {
    return StratumOrder.instance.sortTopToBottom<T>(strata);
  }

  /**
   * Sorts the given strata in top-to-bottom order so that strata with a higher priority value occur
   * later in the returned array.
   * @param strata The strata to sort.
   * @returns The strata sorted bottom-to-top.
   */
  static sortBottomToTop<T>(strata: Map<string, T>): Map<string, T> {
    return StratumOrder.instance.sortBottomToTop<T>(strata);
  }
}