Merge remote-tracking branch 'origin/develop' into
[jalview.git] / src / jalview / gui / OverviewPanel.java
index fc3cc4b..ac2138f 100755 (executable)
@@ -20,7 +20,9 @@
  */
 package jalview.gui;
 
+import jalview.datamodel.SequenceI;
 import jalview.renderer.AnnotationRenderer;
+import jalview.renderer.seqfeatures.FeatureColourFinder;
 import jalview.viewmodel.OverviewDimensions;
 
 import java.awt.Color;
@@ -36,7 +38,8 @@ import java.awt.image.BufferedImage;
 import javax.swing.JPanel;
 
 /**
- * DOCUMENT ME!
+ * Panel displaying an overview of the full alignment, with an interactive box
+ * representing the viewport onto the alignment.
  * 
  * @author $author$
  * @version $Revision$
@@ -68,18 +71,18 @@ public class OverviewPanel extends JPanel implements Runnable
   // main visible SeqCanvas
   private SequenceRenderer sr;
 
-  private jalview.renderer.seqfeatures.FeatureRenderer fr;
+  jalview.renderer.seqfeatures.FeatureRenderer fr;
 
   /**
    * Creates a new OverviewPanel object.
    * 
-   * @param ap
+   * @param alPanel
    *          The alignment panel which is shown in the overview panel
    */
-  public OverviewPanel(AlignmentPanel ap)
+  public OverviewPanel(AlignmentPanel alPanel)
   {
-    this.av = ap.av;
-    this.ap = ap;
+    this.av = alPanel.av;
+    this.ap = alPanel;
     setLayout(null);
 
     sr = new SequenceRenderer(av);
@@ -87,7 +90,7 @@ public class OverviewPanel extends JPanel implements Runnable
     sr.forOverview = true;
     fr = new FeatureRenderer(ap);
 
-    od = new OverviewDimensions(av);
+    od = new OverviewDimensions(av.getRanges(), av.isShowAnnotation());
 
     addComponentListener(new ComponentAdapter()
     {
@@ -109,11 +112,10 @@ public class OverviewPanel extends JPanel implements Runnable
       {
         if (!av.getWrapAlignment())
         {
-          // TODO: feature: jv2.5 detect shift drag and update selection from
-          // it.
-          od.setBoxX(evt.getX());
-          od.setBoxY(evt.getY());
-          checkValid();
+          od.updateViewportFromMouse(evt.getX(), evt.getY(), av
+                  .getAlignment().getHiddenSequences(), av
+                  .getColumnSelection(), av.getRanges());
+          ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
         }
       }
     });
@@ -125,9 +127,10 @@ public class OverviewPanel extends JPanel implements Runnable
       {
         if (!av.getWrapAlignment())
         {
-          od.setBoxX(evt.getX());
-          od.setBoxY(evt.getY());
-          checkValid();
+          od.updateViewportFromMouse(evt.getX(), evt.getY(), av
+                  .getAlignment().getHiddenSequences(), av
+                  .getColumnSelection(), av.getRanges());
+          ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
         }
       }
     });
@@ -136,16 +139,6 @@ public class OverviewPanel extends JPanel implements Runnable
   }
 
   /**
-   * Check box dimensions and scroll positions and correct if necessary
-   */
-  private void checkValid()
-  {
-    od.checkValid();
-    ap.setScrollValues(od.getScrollCol(), od.getScrollRow());
-
-  }
-
-  /**
    * Updates the overview image when the related alignment panel is updated
    */
   public void updateOverviewImage()
@@ -160,8 +153,8 @@ public class OverviewPanel extends JPanel implements Runnable
 
     if ((getWidth() > 0) && (getHeight() > 0))
     {
-      od.setWidth(getWidth()); // width = getWidth();
-      od.setHeight(getHeight()); // sequencesHeight = getHeight() - graphHeight;
+      od.setWidth(getWidth());
+      od.setHeight(getHeight());
     }
 
     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
@@ -192,15 +185,11 @@ public class OverviewPanel extends JPanel implements Runnable
     mg.setColor(Color.orange);
     mg.fillRect(0, 0, od.getWidth(), miniMe.getHeight());
 
-    // calculate scale based on current alignment width and height
-    od.updateScales();
-
     // calculate sampleCol and sampleRow
     // alignment width is max number of residues/bases
     // alignment height is number of sequences
     int alwidth = av.getAlignment().getWidth();
-    int alheight = av.getAlignment().getHeight()
-            + av.getAlignment().getHiddenSequences().getSize();
+    int alheight = av.getAlignment().getAbsoluteHeight();
 
     // sampleCol or sampleRow is the width/height allocated to each residue
     // in particular, sometimes we may need more than one row/col of the
@@ -212,7 +201,7 @@ public class OverviewPanel extends JPanel implements Runnable
 
     buildImage(sampleRow, sampleCol);
 
-    if (av.getAlignmentConservationAnnotation() != null)
+    if (av.isShowAnnotation())
     {
       renderer.updateFromAlignViewport(av);
       for (int col = 0; col < od.getWidth() && !resizeAgain; col++)
@@ -243,14 +232,18 @@ public class OverviewPanel extends JPanel implements Runnable
     setBoxPosition();
   }
 
+  /*
+   * Build the overview panel image
+   */
   private void buildImage(float sampleRow, float sampleCol)
   {
     int lastcol = -1;
     int lastrow = -1;
-    int color = Color.white.getRGB();
+    int rgbColour = Color.white.getRGB();
+
+    SequenceI seq = null;
+    FeatureColourFinder finder = new FeatureColourFinder(fr);
 
-    jalview.datamodel.SequenceI seq = null;
-    final boolean hasHiddenRows = av.hasHiddenRows();
     final boolean hasHiddenCols = av.hasHiddenColumns();
     boolean hiddenRow = false;
     // get hidden row and hidden column map once at beginning.
@@ -266,55 +259,28 @@ public class OverviewPanel extends JPanel implements Runnable
 
         lastrow = currentrow;
 
-        hiddenRow = false;
-        // should be method(s) in Alignment
-        if (hasHiddenRows)
-        {
-          seq = av.getAlignment().getHiddenSequences()
-                  .getHiddenSequence(lastrow);
-          if (seq == null)
-          {
-            int index = av.getAlignment().getHiddenSequences()
-                    .findIndexWithoutHiddenSeqs(lastrow);
-
-            seq = av.getAlignment().getSequenceAt(index);
-          }
-          else
-          {
-            hiddenRow = true;
-          }
-        }
-        else
-        {
-          seq = av.getAlignment().getSequenceAt(lastrow);
-        }
-        // end of Alignment method(s)
-      }
-
-      if (seq == null)
-      {
-        System.out.println(lastrow + " null");
-        continue;
+        // get the sequence which would be at alignment index 'lastrow' if no
+        // rows were hidden, and determine whether it is hidden or not
+        hiddenRow = av.getAlignment().isHidden(lastrow);
+        seq = av.getAlignment().getSequenceAtAbsoluteIndex(lastrow);
       }
 
       for (int col = 0; col < od.getWidth() && !resizeAgain; col++)
       {
         if (doCopy)
         {
-          color = miniMe.getRGB(col, row - 1);
+          rgbColour = miniMe.getRGB(col, row - 1);
         }
         else if ((int) (col * sampleCol) != lastcol
                 || (int) (row * sampleRow) != lastrow)
         {
           lastcol = (int) (col * sampleCol);
-          color = getColumnColourFromSequence(seq, hiddenRow, hasHiddenCols,
-                  lastcol);
+          rgbColour = getColumnColourFromSequence(seq, hiddenRow,
+                  hasHiddenCols, lastcol, finder);
         }
-        // else if ((int) (col * sampleCol) == lastcol && (int) (row *
-        // sampleRow) == lastrow))
-        // we just use the color we already have , so don't need to set it
+        // else we just use the color we already have , so don't need to set it
 
-        miniMe.setRGB(col, row, color);
+        miniMe.setRGB(col, row, rgbColour);
       }
     }
   }
@@ -322,33 +288,26 @@ public class OverviewPanel extends JPanel implements Runnable
   /*
    * Find the colour of a sequence at a specified column position
    */
-  private int getColumnColourFromSequence(jalview.datamodel.SequenceI seq,
-          boolean hiddenRow, boolean hasHiddenCols, int lastcol)
+  private int getColumnColourFromSequence(
+          jalview.datamodel.SequenceI seq,
+          boolean hiddenRow, boolean hasHiddenCols, int lastcol,
+          FeatureColourFinder finder)
   {
-    int color;
-
-    if (seq.getLength() > lastcol)
-    {
-      color = sr.getResidueBoxColour(seq, lastcol).getRGB();
+    Color color = Color.white;
 
-      if (av.isShowSequenceFeatures())
-      {
-        color = fr.findFeatureColour(color, seq, lastcol);
-      }
-    }
-    else
+    if ((seq != null) && (seq.getLength() > lastcol))
     {
-      color = Color.white.getRGB(); // White
+       color = sr.getResidueColour(seq, lastcol, finder);
     }
 
     if (hiddenRow
             || (hasHiddenCols && !av.getColumnSelection()
                     .isVisible(lastcol)))
     {
-      color = new Color(color).darker().darker().getRGB();
+      color = color.darker().darker();
     }
 
-    return color;
+    return color.getRGB();
   }
 
   /**
@@ -358,7 +317,8 @@ public class OverviewPanel extends JPanel implements Runnable
    */
   public void setBoxPosition()
   {
-    od.setBoxPosition();
+    od.setBoxPosition(av.getAlignment()
+            .getHiddenSequences(), av.getColumnSelection(), av.getRanges());
     repaint();
   }
 
@@ -389,11 +349,8 @@ public class OverviewPanel extends JPanel implements Runnable
         g.fillRect(0, 0, getWidth(), getHeight());
       }
     }
-    // TODO: render selected regions
+
     g.setColor(Color.red);
-    g.drawRect(od.getBoxX(), od.getBoxY(), od.getBoxWidth(),
-            od.getBoxHeight());
-    g.drawRect(od.getBoxX() + 1, od.getBoxY() + 1, od.getBoxWidth() - 2,
-            od.getBoxHeight() - 2);
+    od.drawBox(g);
   }
 }