JAL-1432 updated copyright notices
[jalview.git] / src / jalview / renderer / AnnotationRenderer.java
index 84f6589..d951aba 100644 (file)
@@ -1,3 +1,21 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
+ * Copyright (C) 2014 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview 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.
+ *  
+ * Jalview 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.renderer;
 
 import jalview.analysis.AAFrequency;
@@ -18,16 +36,29 @@ import java.awt.Image;
 import java.awt.font.LineMetrics;
 import java.awt.geom.AffineTransform;
 import java.awt.image.ImageObserver;
+import java.util.BitSet;
 import java.util.Hashtable;
 
 import com.stevesoft.pat.Regex;
 
 public class AnnotationRenderer
 {
+  /**
+   * flag indicating if timing and redraw parameter info should be output
+   */
+  private final boolean debugRedraw;
 
   public AnnotationRenderer()
   {
-    // TODO Auto-generated constructor stub
+    this(false);
+  }
+  /**
+   * Create a new annotation Renderer
+   * @param debugRedraw flag indicating if timing and redraw parameter info should be output
+   */
+  public AnnotationRenderer(boolean debugRedraw)
+  {
+    this.debugRedraw=debugRedraw;
   }
 
   public void drawStemAnnot(Graphics g, Annotation[] row_annotations,
@@ -124,7 +155,23 @@ public class AnnotationRenderer
    * width of image to render in panel
    */
   private int imgWidth;
-
+  /**
+   * offset to beginning of visible area
+   */
+  private int sOffset;
+  /**
+   * offset to end of visible area
+   */
+  private int visHeight;
+  /**
+   * indicate if the renderer should only render the visible portion of the annotation given the current view settings
+   */
+  private boolean useClip=true;
+  /**
+   * master flag indicating if renderer should ever try to clip. not enabled for jalview 2.8.1 
+   */
+  private boolean canClip=false;
+  
   // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI
   // av)
   public void updateFromAwtRenderPanel(AwtRenderPanelI annotPanel,
@@ -134,6 +181,22 @@ public class AnnotationRenderer
     annotationPanel = annotPanel;
     fadedImage = annotPanel.getFadedImage();
     imgWidth = annotPanel.getFadedImageWidth();
+    // visible area for rendering
+    int[] bounds=annotPanel.getVisibleVRange();
+    if (bounds!=null)
+    {
+      sOffset = bounds[0];
+      visHeight = bounds[1];
+      if (visHeight==0)
+      {
+        useClip=false;
+      } else {
+        useClip=canClip;
+      }
+    } else {
+      useClip=false;
+    }
+
     updateFromAlignViewport(av);
   }
 
@@ -178,7 +241,7 @@ public class AnnotationRenderer
       }
       // TODO extend annotation row to enable dynamic and static profile data to
       // be stored
-      if (aa.groupRef == null && aa.sequenceRef == null && av_renderProfile)
+      if (aa.groupRef == null && aa.sequenceRef == null)
       {
         return AAFrequency.extractProfile(hconsensus[column],
                 av_ignoreGapsConsensus);
@@ -200,7 +263,7 @@ public class AnnotationRenderer
         // to
         // be stored
         if (aa.groupRef == null && aa.sequenceRef == null
-                && av_renderProfile && hStrucConsensus != null
+                && hStrucConsensus != null
                 && hStrucConsensus.length > column)
         {
           return StructureFrequency.extractProfile(hStrucConsensus[column],
@@ -212,27 +275,39 @@ public class AnnotationRenderer
   }
 
   /**
-   * DOCUMENT ME!
-   *
-   * @param annotationPanel
-   *          TODO
+   * Render the annotation rows associated with an alignment.
+   * 
+   * @param annotPanel
+   *          container frame
+   * @param av
+   *          data and view settings to render
    * @param g
-   *          DOCUMENT ME!
+   *          destination for graphics
+   * @param activeRow
+   *          row where a mouse event occured (or -1)
    * @param startRes
-   *          DOCUMENT ME!
+   *          first column that will be drawn
    * @param endRes
-   *          DOCUMENT ME!
+   *          last column that will be drawn
+   * @return true if the fadedImage was used for any alignment annotation rows
+   *         currently being calculated
    */
-  public void drawComponent(AwtRenderPanelI annotPanel, AlignViewportI av,
-          Graphics g, int activeRow, int startRes, int endRes)
+  public boolean drawComponent(AwtRenderPanelI annotPanel,
+          AlignViewportI av, Graphics g, int activeRow, int startRes,
+          int endRes)
   {
+    long stime=System.currentTimeMillis();
+    boolean usedFaded = false;
     // NOTES:
     // AnnotationPanel needs to implement: ImageObserver, access to
     // AlignViewport
     updateFromAwtRenderPanel(annotPanel, av);
     fm = g.getFontMetrics();
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
-
+    if (aa==null)
+    {
+      return false;
+    }
     int x = 0, y = 0;
     int column = 0;
     char lastSS;
@@ -244,16 +319,42 @@ public class AnnotationRenderer
     boolean centreColLabels, centreColLabelsDef = av
             .getCentreColumnLabels();
     boolean scaleColLabel = false;
-    boolean[] graphGroupDrawn = new boolean[aa.length];
+    AlignmentAnnotation consensusAnnot=av.getAlignmentConsensusAnnotation(),structConsensusAnnot=av.getAlignmentStrucConsensusAnnotation();
+    boolean renderHistogram = true, renderProfile = true, normaliseProfile = false;
+
+    BitSet graphGroupDrawn = new BitSet();
     int charOffset = 0; // offset for a label
     float fmWidth, fmScaling = 1f; // scaling for a label to fit it into a
     // column.
     Font ofont = g.getFont();
     // \u03B2 \u03B1
+    // debug ints
+    int yfrom=0,f_i=0,yto=0,f_to=0;
+    boolean clipst=false,clipend=false;
     for (int i = 0; i < aa.length; i++)
     {
       AlignmentAnnotation row = aa[i];
-      Annotation[] row_annotations=row.annotations;
+      {
+        // check if this is a consensus annotation row and set the display settings appropriately
+        // TODO: generalise this to have render styles for consensus/profile
+        // data
+        if (row.groupRef != null && row == row.groupRef.getConsensus())
+        {
+          renderHistogram = row.groupRef.isShowConsensusHistogram();
+          renderProfile = row.groupRef.isShowSequenceLogo();
+          normaliseProfile = row.groupRef.isNormaliseSequenceLogo();
+        }
+        else if (row == consensusAnnot || row == structConsensusAnnot)
+        {
+          renderHistogram = av_renderHistogram;
+          renderProfile = av_renderProfile;
+          normaliseProfile = av_normaliseProfile;
+        } else {
+          renderHistogram = true;
+          // don't need to set render/normaliseProfile since they are not currently used in any other annotation track renderer
+        }
+      }
+      Annotation[] row_annotations = row.annotations;
       if (!row.visible)
       {
         continue;
@@ -263,10 +364,20 @@ public class AnnotationRenderer
       scaleColLabel = row.scaleColLabel;
       lastSS = ' ';
       lastSSX = 0;
+      
+      if (!useClip || ((y-charHeight)<visHeight && (y+row.height+charHeight*2)>=sOffset)) 
+      {// if_in_visible_region
+        if (!clipst)
+        {
+          clipst=true;
+          yfrom=y;
+          f_i=i;
+        }
+        yto = y;
+        f_to=i;
       if (row.graph > 0)
       {
-        if (row.graphGroup > -1 && graphGroupDrawn[row.graphGroup])
-        {
+        if (row.graphGroup > -1 && graphGroupDrawn.get(row.graphGroup)) {
           continue;
         }
 
@@ -292,7 +403,7 @@ public class AnnotationRenderer
       if (row.autoCalculated && av.isCalculationInProgress(row))
       {
         y += charHeight;
-
+        usedFaded = true;
         g.drawImage(fadedImage, 0, y - row.height, imgWidth, y, 0, y
                 - row.height, imgWidth, y, annotationPanel);
         g.setColor(Color.black);
@@ -304,22 +415,22 @@ public class AnnotationRenderer
       /*
        * else if (annotationPanel.av.updatingConservation &&
        * aa[i].label.equals("Conservation")) {
-       *
+       * 
        * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
        * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
        * annotationPanel.imgWidth, y, annotationPanel);
-       *
+       * 
        * g.setColor(Color.black); //
        * g.drawString("Calculating Conservation.....",20, y-row.height/2);
-       *
+       * 
        * continue; } else if (annotationPanel.av.updatingConservation &&
        * aa[i].label.equals("Quality")) {
-       *
+       * 
        * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
        * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
        * annotationPanel.imgWidth, y, annotationPanel); g.setColor(Color.black);
        * // / g.drawString("Calculating Quality....",20, y-row.height/2);
-       *
+       * 
        * continue; }
        */
       // first pass sets up state for drawing continuation from left-hand column
@@ -451,19 +562,19 @@ public class AnnotationRenderer
               switch (lastSS)
               {
               case 'H':
-                drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                        column, validRes, validEnd);
+                drawHelixAnnot(g, row_annotations, lastSSX, x, y,
+                        iconOffset, startRes, column, validRes, validEnd);
                 break;
 
               case 'E':
-                drawSheetAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                        column, validRes, validEnd);
+                drawSheetAnnot(g, row_annotations, lastSSX, x, y,
+                        iconOffset, startRes, column, validRes, validEnd);
                 break;
 
               case 'S': // Stem case for RNA secondary structure
               case 's': // and opposite direction
-                drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                        column, validRes, validEnd);
+                drawStemAnnot(g, row_annotations, lastSSX, x, y,
+                        iconOffset, startRes, column, validRes, validEnd);
                 break;
 
               default:
@@ -517,22 +628,22 @@ public class AnnotationRenderer
         switch (lastSS)
         {
         case 'H':
-          drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                  column, validRes, validEnd);
+          drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
+                  startRes, column, validRes, validEnd);
           break;
 
         case 'E':
-          drawSheetAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                  column, validRes, validEnd);
+          drawSheetAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
+                  startRes, column, validRes, validEnd);
           break;
         case 's':
         case 'S': // Stem case for RNA secondary structure
-          drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                  column, validRes, validEnd);
+          drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
+                  startRes, column, validRes, validEnd);
           break;
         default:
-          drawGlyphLine(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
-                  column, validRes, validEnd);
+          drawGlyphLine(g, row_annotations, lastSSX, x, y, iconOffset,
+                  startRes, column, validRes, validEnd);
           break;
         }
       }
@@ -541,8 +652,9 @@ public class AnnotationRenderer
       {
         if (row.graph == AlignmentAnnotation.LINE_GRAPH)
         {
-          if (row.graphGroup > -1 && !graphGroupDrawn[row.graphGroup])
+          if (row.graphGroup > -1 && !graphGroupDrawn.get(row.graphGroup))
           {
+            // TODO: JAL-1291 revise rendering model so the graphGroup map is computed efficiently for all visible labels
             float groupmax = -999999, groupmin = 9999999;
             for (int gg = 0; gg < aa.length; gg++)
             {
@@ -555,7 +667,6 @@ public class AnnotationRenderer
               {
                 aa[gg].visible = false;
               }
-
               if (aa[gg].graphMax > groupmax)
               {
                 groupmax = aa[gg].graphMax;
@@ -570,26 +681,31 @@ public class AnnotationRenderer
             {
               if (aa[gg].graphGroup == row.graphGroup)
               {
-                drawLineGraph(g, aa[gg], aa[gg].annotations, startRes, endRes, y, groupmin,
-                        groupmax, row.graphHeight);
+                drawLineGraph(g, aa[gg], aa[gg].annotations, startRes,
+                        endRes, y, groupmin, groupmax, row.graphHeight);
               }
             }
 
-            graphGroupDrawn[row.graphGroup] = true;
+            graphGroupDrawn.set(row.graphGroup);
           }
           else
           {
-            drawLineGraph(g, row, row_annotations, startRes, endRes, y, row.graphMin,
-                    row.graphMax, row.graphHeight);
+            drawLineGraph(g, row, row_annotations, startRes, endRes, y,
+                    row.graphMin, row.graphMax, row.graphHeight);
           }
         }
         else if (row.graph == AlignmentAnnotation.BAR_GRAPH)
         {
-          drawBarGraph(g, row, row_annotations, startRes, endRes, row.graphMin,
-                  row.graphMax, y);
+          drawBarGraph(g, row, row_annotations, startRes, endRes,
+                  row.graphMin, row.graphMax, y, renderHistogram,renderProfile,normaliseProfile);
         }
       }
-
+    } else {
+      if (clipst && !clipend)
+      {
+        clipend = true;
+      }
+    }// end if_in_visible_region
       if (row.graph > 0 && row.hasText)
       {
         y += charHeight;
@@ -600,6 +716,28 @@ public class AnnotationRenderer
         y += aa[i].height;
       }
     }
+    if (debugRedraw)
+    {
+      if (canClip)
+      {
+        if (clipst)
+        {
+          System.err.println("Start clip at : " + yfrom + " (index " + f_i
+                  + ")");
+        }
+        if (clipend)
+        {
+          System.err.println("End clip at : " + yto + " (index " + f_to
+                  + ")");
+        }
+      }
+      ;
+      System.err.println("Annotation Rendering time:"
+              + (System.currentTimeMillis() - stime));
+    }
+    ;
+
+    return !usedFaded;
   }
 
   private final Color GLYPHLINE_COLOR = Color.gray;
@@ -610,21 +748,21 @@ public class AnnotationRenderer
 
   private final Color STEM_COLOUR = Color.blue;
 
-  public void drawGlyphLine(Graphics g, Annotation[] row,
-          int lastSSX, int x, int y, int iconOffset, int startRes,
-          int column, boolean validRes, boolean validEnd)
+  public void drawGlyphLine(Graphics g, Annotation[] row, int lastSSX,
+          int x, int y, int iconOffset, int startRes, int column,
+          boolean validRes, boolean validEnd)
   {
     g.setColor(GLYPHLINE_COLOR);
     g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth) - lastSSX, 2);
   }
 
-  public void drawSheetAnnot(Graphics g, Annotation[] row,
-          int lastSSX, int x, int y, int iconOffset, int startRes,
-          int column, boolean validRes, boolean validEnd)
+  public void drawSheetAnnot(Graphics g, Annotation[] row, int lastSSX,
+          int x, int y, int iconOffset, int startRes, int column,
+          boolean validRes, boolean validEnd)
   {
     g.setColor(SHEET_COLOUR);
 
-    if (!validEnd || !validRes || row==null || row[column] == null
+    if (!validEnd || !validRes || row == null || row[column] == null
             || row[column].secondaryStructure != 'E')
     {
       g.fillRect(lastSSX, y + 4 + iconOffset,
@@ -643,9 +781,9 @@ public class AnnotationRenderer
 
   }
 
-  public void drawHelixAnnot(Graphics g, Annotation[] row,
-          int lastSSX, int x, int y, int iconOffset, int startRes,
-          int column, boolean validRes, boolean validEnd)
+  public void drawHelixAnnot(Graphics g, Annotation[] row, int lastSSX,
+          int x, int y, int iconOffset, int startRes, int column,
+          boolean validRes, boolean validEnd)
   {
     g.setColor(HELIX_COLOUR);
 
@@ -703,8 +841,9 @@ public class AnnotationRenderer
     g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 8);
   }
 
-  public void drawLineGraph(Graphics g, AlignmentAnnotation _aa, Annotation[] aa_annotations, int sRes,
-          int eRes, int y, float min, float max, int graphHeight)
+  public void drawLineGraph(Graphics g, AlignmentAnnotation _aa,
+          Annotation[] aa_annotations, int sRes, int eRes, int y,
+          float min, float max, int graphHeight)
   {
     if (sRes > aa_annotations.length)
     {
@@ -792,8 +931,9 @@ public class AnnotationRenderer
     }
   }
 
-  public void drawBarGraph(Graphics g, AlignmentAnnotation _aa, Annotation[] aa_annotations, int sRes,
-          int eRes, float min, float max, int y)
+  public void drawBarGraph(Graphics g, AlignmentAnnotation _aa,
+          Annotation[] aa_annotations, int sRes, int eRes, float min,
+          float max, int y, boolean renderHistogram,boolean renderProfile,boolean normaliseProfile)
   {
     if (sRes > aa_annotations.length)
     {
@@ -817,23 +957,6 @@ public class AnnotationRenderer
 
     int column;
     int aaMax = aa_annotations.length - 1;
-    boolean renderHistogram = true, renderProfile = true, normaliseProfile = false;
-    // if (aa.autoCalculated && aa.label.startsWith("Consensus"))
-    {
-      // TODO: generalise this to have render styles for consensus/profile data
-      if (_aa.groupRef != null)
-      {
-        renderHistogram = _aa.groupRef.isShowConsensusHistogram();
-        renderProfile = _aa.groupRef.isShowSequenceLogo();
-        normaliseProfile = _aa.groupRef.isNormaliseSequenceLogo();
-      }
-      else
-      {
-        renderHistogram = av_renderHistogram;
-        renderProfile = av_renderProfile;
-        normaliseProfile = av_normaliseProfile;
-      }
-    }
     while (x < eRes - sRes)
     {
       column = sRes + x;
@@ -929,7 +1052,7 @@ public class AnnotationRenderer
               // g.drawRect(x*av.charWidth, (int)ht, av.charWidth,
               // (int)(scl));
               // g.setColor(profcolour.findColour(dc[0]).darker());
-              g.setColor(profcolour.findColour(dc[0], column,null));
+              g.setColor(profcolour.findColour(dc[0], column, null));
 
               hght = (ht + (scl - lm.getDescent() - lm.getBaselineOffsets()[lm
                       .getBaselineIndex()]));
@@ -950,15 +1073,16 @@ public class AnnotationRenderer
               BasicStroke.JOIN_ROUND, 3f, new float[]
               { 5f, 3f }, 0f));
 
-      y2 = (int) (y - ((_aa.threshold.value - min) / range) * _aa.graphHeight);
+      y2 = (int) (y - ((_aa.threshold.value - min) / range)
+              * _aa.graphHeight);
       g.drawLine(0, y2, (eRes - sRes) * charWidth, y2);
       g2.setStroke(new BasicStroke());
     }
   }
 
   // used by overview window
-  public void drawGraph(Graphics g, AlignmentAnnotation _aa, Annotation[] aa_annotations, int width,
-          int y, int sRes, int eRes)
+  public void drawGraph(Graphics g, AlignmentAnnotation _aa,
+          Annotation[] aa_annotations, int width, int y, int sRes, int eRes)
   {
     eRes = Math.min(eRes, aa_annotations.length);
     g.setColor(Color.white);