source: branches/HeuristicLab.EvolutionTracking/HeuristicLab.EvolutionTracking.Views/3.4/GenealogyGraphChart.cs @ 13399

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Linq;
using System.Windows.Forms;
using HeuristicLab.Common;
using HeuristicLab.Visualization;

namespace HeuristicLab.EvolutionTracking.Views {
  public partial class GenealogyGraphChart : ChartControl {
    private IGenealogyGraph genealogyGraph;

    private const double XIncrement = 30;
    private const double YIncrement = 30;
    private const double Diameter = 20;

    private readonly Brush defaultBrush;
    private readonly Pen defaultPen;

    private Dictionary<IGenealogyGraphNode, VisualGenealogyGraphNode> nodeMap;
    private Dictionary<Tuple<VisualGenealogyGraphNode, VisualGenealogyGraphNode>, VisualGenealogyGraphArc> arcMap;

    #region chart options
    public bool SimpleLineages { get; set; }
    public bool LockGenealogy { get; set; }
    public bool TraceFragments { get; set; }
    #endregion

    #region chart modes
    public Dictionary<string, ChartMode> ChartMode { get; private set; }
    #endregion

    private bool DrawInProgress { get; set; } // do not try to update the chart while the drawing is not finished

    public IGenealogyGraph GenealogyGraph {
      get { return genealogyGraph; }
      set {
        if (value == null) return;
        genealogyGraph = value;
        Clear();
        DrawGraph(XIncrement, YIncrement, Diameter);
      }
    }

    public IGenealogyGraphNode SelectedGraphNode {
      get {
        return SelectedVisualNode == null ? null : SelectedVisualNode.Data;
      }
      set {
        if (value == null || value == SelectedGraphNode)
          return;
        SelectedVisualNode = GetMappedNode(value);
        UpdateSelectedVisualNode();
      }
    }

    private void Clear() {
      nodeMap = new Dictionary<IGenealogyGraphNode, VisualGenealogyGraphNode>();
      arcMap = new Dictionary<Tuple<VisualGenealogyGraphNode, VisualGenealogyGraphNode>, VisualGenealogyGraphArc>();

      Chart.Group.Clear();
    }

    private Visualization.Rectangle TargetRectangle { get; set; }
    protected VisualGenealogyGraphNode SelectedVisualNode { get; set; }

    public VisualGenealogyGraphNode GetMappedNode(IGenealogyGraphNode node) {
      VisualGenealogyGraphNode v;
      nodeMap.TryGetValue(node, out v);
      return v;
    }

    public VisualGenealogyGraphArc GetMappedArc(IGenealogyGraphNode source, IGenealogyGraphNode target) {
      VisualGenealogyGraphNode visualSource, visualTarget;
      nodeMap.TryGetValue(source, out visualSource);
      nodeMap.TryGetValue(target, out visualTarget);

      if (visualSource == null || visualTarget == null) return null;

      VisualGenealogyGraphArc arc;
      arcMap.TryGetValue(new Tuple<VisualGenealogyGraphNode, VisualGenealogyGraphNode>(visualSource, visualTarget), out arc);
      return arc;
    }

    public GenealogyGraphChart() {
      InitializeComponent();

      ChartMode = new Dictionary<string, ChartMode> {
        { "Select", new SelectChartMode(this) },
        { "ZoomIn", new ZoomInChartMode(this) },
        { "ZoomOut", new ZoomOutChartMode(this) },
        { "Pan", new PanChartMode(this) }
      };

      defaultBrush = new SolidBrush(Color.Transparent);
      defaultPen = new Pen(Color.DarkGray);
    }

    protected virtual void DrawGraph(double xIncrement, double yIncrement, double diameter) {
      this.SuspendRendering();
      DrawInProgress = true;

      var ranks = GenealogyGraph.Ranks.Select(t => new { Rank = t.Key, Nodes = t.Value }).OrderBy(p => p.Rank).ToList();
      double x = 0;
      double y = PreferredSize.Height + yIncrement + 2 * diameter;

      foreach (var rank in ranks) {
        var nodes = rank.Nodes.ToList();
        nodes.Sort((a, b) => b.CompareTo(a)); // sort descending by quality
        var nl = Environment.NewLine;

        foreach (var node in nodes) {
          var brush = new SolidBrush(node.GetColor());
          var visualNode = new VisualGenealogyGraphNode(Chart, x, y, x + diameter, y + diameter, defaultPen, brush) {
            Data = node,
            ToolTipText = "Rank: " + node.Rank + nl +
                          "Quality: " + String.Format("{0:0.0000}", node.Quality) + nl +
                          "IsElite: " + node.IsElite + nl +
                          "In/Out Degree: " + node.InDegree + " " + node.OutDegree
          };
          Chart.Group.Add(visualNode);
          nodeMap.Add(node, visualNode);

          x += xIncrement;
        }
        y -= yIncrement;
        x = 0;
      }

      // add arcs
      foreach (var node in GenealogyGraph.Vertices) {
        if (!node.InArcs.Any()) continue;
        var visualNode = GetMappedNode(node);

        if (visualNode == null) continue;
        foreach (var arc in node.InArcs) {
          var parent = arc.Source;
          var visualParent = GetMappedNode(parent);
          if (visualParent == null) continue;
          var pen = Pens.Transparent;
          var visualArc = AddArc(Chart, visualParent, visualNode, pen);
          Chart.OneLayerDown(visualArc); // send it behind the visual nodes
          if (!arcMap.ContainsKey(Tuple.Create(visualParent, visualNode))) {
            arcMap.Add(Tuple.Create(visualParent, visualNode), visualArc);
          }
        }
      }

      ResumeRendering();
      DrawInProgress = false;
    }

    public event MouseEventHandler GenealogyGraphNodeClicked;
    protected void OnGenealogyGraphNodeClicked(object sender, MouseEventArgs e) {
      var clicked = GenealogyGraphNodeClicked;
      if (clicked != null) clicked(sender, e);
    }

    public event MouseEventHandler GenealogyGraphNodeDoubleClicked;
    protected void OnGenealogyGraphNodeDoubleClicked(object sender, MouseEventArgs e) {
      var doubleClicked = GenealogyGraphNodeDoubleClicked;
      if (doubleClicked != null)
        doubleClicked(sender, e);
    }
    #region event handlers

    protected override void PictureBoxOnMouseMove(object sender, MouseEventArgs e) {
      if (!DrawInProgress) {
        switch (e.Button) {
          case MouseButtons.Left:
            Mode = ChartMode["Select"];
            Cursor = Cursors.Default;
            break;
          case MouseButtons.Middle:
            Mode = ChartMode["Pan"];
            Cursor = Cursors.Hand;
            break;
        }
      }
      base.PictureBoxOnMouseMove(sender, e);
    }

    protected override void PictureBoxOnMouseUp(object sender, MouseEventArgs e) {
      Cursor = Cursors.Default;

      var primitive = Chart.GetAllPrimitives(e.Location).FirstOrDefault(p => p is VisualGenealogyGraphNode);
      if (primitive == null) {
        SelectedVisualNode = null;
        return;
      }
      if (SelectedVisualNode == primitive) return;
      SelectedVisualNode = primitive as VisualGenealogyGraphNode;
      if (SelectedVisualNode == null) return;

      UpdateSelectedVisualNode(); // redraw ancestries, mark node etc.

      base.PictureBoxOnMouseUp(sender, e);
    }

    private void UpdateSelectedVisualNode() {
      if (!LockGenealogy) {
        // new node has been selected, clean up
        SuspendRendering();
        if (ModifierKeys != Keys.Shift) {
          // clear colors
          ClearPrimitives();
        }
        // use a rectangle to highlight the currently selected genealogy graph node
        var graphNode = SelectedVisualNode.Data;
        var visualNode = GetMappedNode(graphNode);

        DrawLineage(visualNode, n => SimpleLineages ? n.IncomingArcs.Take(1) : n.IncomingArcs, a => a.Source);
        ((SolidBrush)visualNode.Brush).Color = Color.Transparent;
        DrawLineage(visualNode, n => n.OutgoingArcs, a => a.Target);
      }

      MarkSelectedNode();

      // update
      ResumeRendering();

      if (SelectedVisualNode != null)
        OnGenealogyGraphNodeClicked(SelectedVisualNode, null); // emit clicked event
    }
    #endregion

    #region drawing routines
    private static void DrawLineage(VisualGenealogyGraphNode node, Func<VisualGenealogyGraphNode, IEnumerable<VisualGenealogyGraphArc>> arcSelector, Func<VisualGenealogyGraphArc, VisualGenealogyGraphNode> nodeSelector) {
      var brush = (SolidBrush)node.Brush;
      if (brush.Color != Color.Transparent) return; // this lineage was already drawn (avoid redrawing common ancestors)
      brush.Color = node.Data.GetColor();
      var arcs = arcSelector(node);
      var pen = new Pen(Color.Transparent);
      foreach (var arc in arcs) {
        var source = arc.Source.Data;
        var target = arc.Target.Data;
        var start = new Point((int)arc.Start.X, (int)arc.Start.Y);
        var end = new Point((int)arc.End.X, (int)arc.End.Y);
        arc.Pen = pen;
        arc.Pen.Brush = new LinearGradientBrush(start, end, source.GetColor(), target.GetColor());
        DrawLineage(nodeSelector(arc), arcSelector, nodeSelector);
      }
    }

    void MarkSelectedNode() {
      var center = SelectedVisualNode.Center;
      var size = SelectedVisualNode.Size;
      double x1 = center.X - size.Width / 2;
      double x2 = x1 + size.Width;
      double y1 = center.Y - size.Height / 2;
      double y2 = y1 + size.Height;
      if (TargetRectangle == null) {
        var lowerLeft = new PointD(x1, y1);
        var upperRight = new PointD(x2, y2);
        TargetRectangle = new Visualization.Rectangle(Chart, lowerLeft, upperRight, new Pen(Color.Black), null);
        Chart.Group.Add(TargetRectangle);
      } else {
        var lowerLeft = new PointD(x1, y1);
        var upperRight = new PointD(x2, y2);
        TargetRectangle.SetPosition(lowerLeft, upperRight);
      }
    }

    private static VisualGenealogyGraphArc AddArc(IChart chart, VisualGenealogyGraphNode source, VisualGenealogyGraphNode target, Pen pen, Brush brush = null) {
      var arc = new VisualGenealogyGraphArc(chart, source, target, pen) { Brush = brush };
      arc.UpdatePosition();
      source.OutgoingArcs.Add(arc);
      target.IncomingArcs.Add(arc);
      chart.Group.Add(arc);
      return arc;
    }

    public void ClearArcs() {
      foreach (var primitive in Chart.Group.Primitives.OfType<VisualGenealogyGraphArc>()) {
        primitive.Pen = Pens.Transparent;
      }
    }

    public void ClearNodes() {
      foreach (var primitive in Chart.Group.Primitives.OfType<VisualGenealogyGraphNode>()) {
        primitive.Brush = new SolidBrush(Color.Transparent);
        primitive.Pen = new Pen(Color.LightGray);
      }
    }

    public virtual void ClearPrimitives() {
      foreach (var primitive in Chart.Group.Primitives) {
        if (primitive is VisualGenealogyGraphArc) {
          primitive.Pen = Pens.Transparent;
        } else if (primitive is VisualGenealogyGraphNode) {
          primitive.Brush = new SolidBrush(Color.Transparent);
          primitive.Pen = new Pen(Color.DarkGray);
        }
      }
    }

    public void HighlightNodes(IEnumerable<IGenealogyGraphNode> nodes, bool clearPrimitives = true) {
      if (clearPrimitives)
        ClearPrimitives();

      foreach (var node in nodes) {
        var graphNode = GetMappedNode(node);
        graphNode.Brush = new SolidBrush(node.GetColor());
      }
    }

    public void HighlightNodes(IEnumerable<IGenealogyGraphNode> nodes, Color color, bool clearPrimitives = true) {
      if (clearPrimitives)
        ClearPrimitives();

      foreach (var node in nodes.Select(GetMappedNode)) {
        node.Brush = new SolidBrush(color);
      }
    }

    public void HighlightAll() {
      foreach (var visualNode in nodeMap.Values) {
        visualNode.Brush = new SolidBrush(visualNode.Data.GetColor());
      }
      foreach (var arc in arcMap.Values) {
        var source = arc.Source.Data;
        var target = arc.Target.Data;
        var start = new Point((int)arc.Start.X, (int)arc.Start.Y);
        var end = new Point((int)arc.End.X, (int)arc.End.Y);
        arc.Pen.Brush = new LinearGradientBrush(start, end, source.GetColor(), target.GetColor());
      }
    }

    public void HighlightArc(IGenealogyGraphNode source, IGenealogyGraphNode target) {
      var arc = GetMappedArc(source, target) ??
                AddArc(Chart, GetMappedNode(source), GetMappedNode(target), new Pen(Color.Transparent));
      var start = new Point((int)arc.Start.X, (int)arc.Start.Y);
      var end = new Point((int)arc.End.X, (int)arc.End.Y);
      arc.Pen = new Pen(Color.Transparent);
      arc.Pen.Brush = new LinearGradientBrush(start, end, source.GetColor(), target.GetColor());
    }
    #endregion
  }

  internal static class Util {
    public static Color GetColor(this IGenealogyGraphNode node) {
      if (double.IsNaN(node.Quality))
        return ColorGradient.Colors[0];
      var colorIndex = (int)Math.Round(node.Quality * ColorGradient.Colors.Count);
      if (colorIndex >= ColorGradient.Colors.Count) return ColorGradient.Colors.Last();
      return ColorGradient.Colors[colorIndex];
    }
  }
}