Merge branch 'JAL-1445' into develop
[jalview.git] / src / jalview / renderer / AnnotationRenderer.java
index cb53eb6..1b58dbc 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -14,6 +14,7 @@
  * 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;
 
@@ -35,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,
@@ -143,9 +157,25 @@ 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 drawPseudoNode(Graphics g, Color nonCanColor, Annotation[] row_annotations,
+  public void drawNotCanonicalAnnot(Graphics g, Color nonCanColor, Annotation[] row_annotations,
           int lastSSX, int x, int y, int iconOffset, int startRes,
           int column, boolean validRes, boolean validEnd)
   {
@@ -212,6 +242,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);
   }
 
@@ -256,7 +302,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);
@@ -278,7 +324,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],
@@ -311,6 +357,7 @@ public class AnnotationRenderer
           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
@@ -319,6 +366,10 @@ public class AnnotationRenderer
     fm = g.getFontMetrics();
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
     int temp = 0;
+    if (aa==null)
+    {
+      return false;
+    }
     int x = 0, y = 0;
     int column = 0;
     char lastSS;
@@ -330,15 +381,41 @@ 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];
+      {
+        // 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)
       {
@@ -349,10 +426,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;
         }
 
@@ -565,31 +652,30 @@ public class AnnotationRenderer
            }
            if (ss >=65)
            {
-                 // System.out.println("ss="+ss);
              // distinguish between forward/backward base-pairing
              if (row_annotations[column].displayCharacter.indexOf(ss+32) > -1)
              {
-            
-               ss = (char) (ss+32);
               
+               ss = (char) (ss+32);
+               
                
              }
            }
-
            
+               
           if (!validRes || (ss != lastSS))
-          {
-                 
-     
+             {
+               
+               
             if (x > -1)
-            {
-        
-               
+             {
+               
+               
               int nb_annot=x-temp;
               //System.out.println("\t type :"+lastSS+"\t x :"+x+"\t nbre annot :"+nb_annot);
               switch (lastSS)
-              {
-              
+             {
+               
               case '$':
                 drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
                         column, validRes, validEnd);
@@ -602,8 +688,6 @@ public class AnnotationRenderer
 
               case '(': // Stem case for RNA secondary structure
               case ')': // and opposite direction
-                 
-                 
                 drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
                         column, validRes, validEnd);
                 temp=x;
@@ -668,7 +752,7 @@ public class AnnotationRenderer
               case 'z':
                  
                  Color nonCanColor= getNotCanonicalColor(lastSS);
-                 drawPseudoNode(g, nonCanColor, row_annotations, lastSSX, x, y, iconOffset, startRes,
+                 drawNotCanonicalAnnot(g, nonCanColor, row_annotations, lastSSX, x, y, iconOffset, startRes,
                           column, validRes, validEnd);
                  temp=x;
                  break;
@@ -795,13 +879,10 @@ public class AnnotationRenderer
         case 'Z':
         case 'z':
                //System.out.println(lastSS);
-               
           Color nonCanColor = getNotCanonicalColor(lastSS);
-         drawPseudoNode(g,nonCanColor, row_annotations, lastSSX, x, y, iconOffset, startRes,
+         drawNotCanonicalAnnot(g,nonCanColor, row_annotations, lastSSX, x, y, iconOffset, startRes,
                     column, validRes, validEnd);
-       
          break;
-         
         default:
           drawGlyphLine(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
                   column, validRes, validEnd);
@@ -813,8 +894,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++)
             {
@@ -827,7 +909,6 @@ public class AnnotationRenderer
               {
                 aa[gg].visible = false;
               }
-
               if (aa[gg].graphMax > groupmax)
               {
                 groupmax = aa[gg].graphMax;
@@ -847,7 +928,7 @@ public class AnnotationRenderer
               }
             }
 
-            graphGroupDrawn[row.graphGroup] = true;
+            graphGroupDrawn.set(row.graphGroup);
           }
           else
           {
@@ -857,11 +938,16 @@ public class AnnotationRenderer
         }
         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;
@@ -872,6 +958,27 @@ 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;
   }
 
@@ -1071,7 +1178,7 @@ public class AnnotationRenderer
 
   public void drawBarGraph(Graphics g, AlignmentAnnotation _aa,
           Annotation[] aa_annotations, int sRes, int eRes, float min,
-          float max, int y)
+          float max, int y, boolean renderHistogram,boolean renderProfile,boolean normaliseProfile)
   {
     if (sRes > aa_annotations.length)
     {
@@ -1095,23 +1202,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;