architype/LayoutLink.js

class LayoutLink {
  constructor(from, to, id, label, labelId, nodesByPos, linksByPos,
              labelsByPos) {
    this.from_ = from;
    this.to_ = to;
    this.id_ = id;
    this.label_ = label;
    this.labelId_ = labelId;
    this.nodesByPos_ = nodesByPos;
    this.linksByPos_ = linksByPos;
    this.labelsByPos_ = labelsByPos;

    // Mapping to lines.svg clock-style numbering
    this.outPointLookup_ = new StringMap([
      [[ 0,-1], 0],
      [[ 1,-1], 1],
      [[ 1, 0], 2],
      [[ 1, 1], 3],
      [[ 0, 1], 4],
      [[-1, 1], 5],
      [[-1, 0], 6],
      [[-1,-1], 7],
    ]);

    this.bfs();
  }

  bfs() {
    let bestByPos = new StringMap();

    // BFS work queue
    let queue = new MinHeap((a) => a.cost);
    queue.push(...[
      {
        path: [Array.from(this.from_.pos)],
        cost: 0,
        source: 1,
      },
      {
        path: [Array.from(this.to_.pos)],
        cost: 0,
        source: 2,
      },
    ]);

    for (let next = queue.pop(); next; next = queue.pop()) {
      let pos = next.path[next.path.length - 1];

      let best = bestByPos.get(pos);
      if (best) {
        if (best.source != next.source) {
          // Goal reached; encountered a path from the other source
          best.path.reverse();
          next.path.splice(next.path.length - 1, 1);
          this.path = next.path.concat(best.path);
          if (next.source == 2) {
            // path is backward because this half of the path started from the
            // end point. Fix it so the arrows end up in the right places.
            this.path.reverse();
          }
          break;
        }

        if (best.cost <= next.cost) {
          // Reached a previous pos via a higher- or equal-cost path
          continue;
        }
      }
      bestByPos.set(pos, next);

      for (let xOff of [-1, 0, 1]) {
        for (let yOff of [-1, 0, 1]) {
          if (xOff == 0 && yOff == 0) {
            continue;
          }
          let newPos = [pos[0] + xOff, pos[1] + yOff];
          let path = Array.from(next.path);
          path.push(newPos);
          queue.push({
            path: path,
            cost: next.cost + this.getCost(pos, newPos),
            source: next.source,
          });
        }
      }
    }

    for (let i = 0; i < this.path.length; ++i) {
      let hop = this.path[i];
      let prevHop = this.path[i - 1];
      let nextHop = this.path[i + 1];

      if (prevHop) {
        let links = getOrSet(
            this.linksByPos_,
            [hop, this.getInPoint(prevHop, hop)],
            new Set());
        links.add('f' + this.from_.pos.toString());
        links.add('t' + this.to_.pos.toString());
      }

      if (nextHop) {
        let links = getOrSet(
            this.linksByPos_,
            [hop, this.getOutPoint(hop, nextHop)],
            new Set());
        links.add('f' + this.from_.pos.toString());
        links.add('t' + this.to_.pos.toString());
      }
    }
  }

  getCost(from, to) {
    // Only handles adjacent positions

    let cost = 1;

    // Because we're doing bidirectional search, this function must always be
    // symmetric, i.e. returning the same value regardless of order of
    // arguments. That means that any costs applied to nodes must be applied
    // whether the node is from or to. Traversal is double-charged.
    for (let pos of [from, to]) {
      let taken = this.nodesByPos_.get(pos);
      if (taken instanceof LayoutGroup &&
          (this.from_.groups.has(taken) ||
           this.to_.groups.has(taken))) {
        // We're going to or from this group, so traversing it is only slightly
        // discouraged.
        cost += 0.1;
      } else if (taken) {
        // Traversing nodes has higher cost
        cost += 5;
      }
    }

    // Overlapping links have cost, but not if they are from or to the same
    // node we are (which render as merging or splitting lines). Allowing
    // that saves space. We XOR because we want to force apart lines between
    // the same pair, e.g. for redundant or cyclical links.
    for (let key of [[from, this.getOutPoint(from, to)],
                     [to, this.getInPoint(from, to)]]) {
      // inPoint/outPoint is part of the key because we only count the lines
      // as "overlapping" if they travel together, not if they just cross.
      let links = this.linksByPos_.get(key);
      if (!links) {
        continue;
      }
      let hasFrom = links.has('f' + this.from_.pos.toString());
      let hasTo = links.has('t' + this.to_.pos.toString());
      if (hasFrom && hasTo) {
        // Push apart lines between the same pair
        cost += 2;
      } else if (hasFrom || hasTo) {
        // Encourage merging
        cost -= 0.25;
      } else {
        cost += 5;
      }
    }

    let offset = [
        to[0] - from[0],
        to[1] - from[1],
    ];
    if (offset[0] != 0 && offset[1] != 0) {
      // Diagonal; approximate sqrt(2) from distance formula
      cost += 0.4;
    }

    return cost;
  }

  getOutPoint(from, to) {
    let offset = [
        to[0] - from[0],
        to[1] - from[1],
    ];
    return this.outPointLookup_.get(offset);
  }

  getInPoint(from, to) {
    return (this.getOutPoint(from, to) + 4) % 8;
  }

  drawLabel() {
    if (this.label_ == null || this.label_ == '') {
      return;
    }

    let minScore = Number.POSITIVE_INFINITY;
    let labelPos = null;

    for (let i = 1; i < this.path.length - 1; ++i) {
      let pos = this.path[i];
      let score = 0;

      let nodeByPos = this.nodesByPos_.get(pos);
      if (nodeByPos instanceof LayoutNode) {
        // Never overlap nodes
        continue;
      } else if (nodeByPos) {
        // Slight preference to not be over a group
        score += 1;
      }

      if (this.labelsByPos_.get(pos) == this.label_) {
        // Already labeled by another link
        return;
      }

      // TODO: cheaper if we overlap with other links with the same label?
      // TODO: don't overlap with links not with the same label

      if (score < minScore) {
        minScore = score;
        labelPos = pos;
      }
    }

    if (labelPos) {
      this.labelPos_ = labelPos;
      this.labelsByPos_.set(this.labelPos_, this.label_);
    }
  }

  getSteps() {
    let steps = [];

    steps.push({
      type: 'line',
      id: this.id_,
      pos: Array.from(this.path[0]),
      cls: 's' + this.getOutPoint(this.path[0], this.path[1]),
    });

    for (let i = 1; i < this.path.length - 1; ++i) {
      let inPoint = this.getInPoint(this.path[i - 1], this.path[i]);
      let outPoint = this.getOutPoint(this.path[i], this.path[i + 1]);
      steps.push({
        type: 'line',
        id: this.id_,
        pos: Array.from(this.path[i]),
        cls: `i${inPoint}o${outPoint}`,
      });
    }

    let endInPoint = this.getInPoint(this.path[this.path.length - 2],
                                     this.path[this.path.length - 1]);

    steps.push({
      type: 'line',
      id: this.id_,
      pos: Array.from(this.path[this.path.length - 1]),
      cls: 's' + endInPoint,
    });

    steps.push({
      type: 'arrow',
      id: this.id_,
      pos: Array.from(this.path[this.path.length - 1]),
      cls: 'a' + endInPoint,
    });

    if (this.labelPos_) {
      steps.push({
        type: 'linkLabel',
        id: this.labelId_,
        pos: this.labelPos_,
        label: this.label_,
      });
    }

    return steps;
  }
}