Merge branch 'develop' into develop_m2_8_1_2
[jalview.git] / src / jalview / renderer / AnnotationRenderer.java
index 7598f5f..6d00118 100644 (file)
@@ -42,10 +42,22 @@ 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,
@@ -70,6 +82,7 @@ public class AnnotationRenderer
     // If a closing base pair half of the stem, display a backward arrow
     if (column > 0 && closeparen.search(dc))
     {
+       
       if (diffupstream)
       // if (validRes && column>1 && row_annotations[column-2]!=null &&
       // dc.equals(row_annotations[column-2].displayCharacter))
@@ -86,6 +99,7 @@ public class AnnotationRenderer
     }
     else
     {
+       
       // display a forward arrow
       if (diffdownstream)
       {
@@ -142,7 +156,82 @@ 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,
+          int lastSSX, int x, int y, int iconOffset, int startRes,
+          int column, boolean validRes, boolean validEnd)
+  {
+       //System.out.println(nonCanColor);
+       
+    g.setColor(nonCanColor);
+    int sCol = (lastSSX / charWidth) + startRes;
+    int x1 = lastSSX;
+    int x2 = (x * charWidth);
+    Regex closeparen = new Regex("}|]|<|[a-z]");
+    
+    String dc = (column == 0 || row_annotations[column - 1] == null) ? ""
+            : row_annotations[column - 1].displayCharacter;
+
+    boolean diffupstream = sCol == 0 || row_annotations[sCol - 1] == null
+            || !dc.equals(row_annotations[sCol - 1].displayCharacter);
+    boolean diffdownstream = !validRes || !validEnd
+            || row_annotations[column] == null
+            || !dc.equals(row_annotations[column].displayCharacter);
+    // System.out.println("Column "+column+" diff up: "+diffupstream+" down:"+diffdownstream);
+    // If a closing base pair half of the stem, display a backward arrow
+    if (column > 0 && closeparen.search(dc))//  closeletter_b.search(dc)||closeletter_c.search(dc)||closeletter_d.search(dc)||closecrochet.search(dc)) )
+    {
+       
+      if (diffupstream)
+      // if (validRes && column>1 && row_annotations[column-2]!=null &&
+      // dc.equals(row_annotations[column-2].displayCharacter))
+      {
+        g.fillPolygon(new int[]
+        { lastSSX + 5, lastSSX + 5, lastSSX }, new int[]
+        { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset }, 3);
+        x1 += 5;
+      }
+      if (diffdownstream)
+      {
+        x2 -= 1;
+      }
+    }
+    else
+    {
+       
+      // display a forward arrow
+      if (diffdownstream)
+      {
+        g.fillPolygon(new int[]
+        { x2 - 5, x2 - 5, x2 }, new int[]
+        { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset }, 3);
+        x2 -= 5;
+      }
+      if (diffupstream)
+      {
+        x1 += 1;
+      }
+    }
+    // draw arrow body
+    g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 7);
+  }
   // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI
   // av)
   public void updateFromAwtRenderPanel(AwtRenderPanelI annotPanel,
@@ -152,6 +241,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);
   }
 
@@ -251,6 +356,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
@@ -258,6 +364,7 @@ public class AnnotationRenderer
     updateFromAwtRenderPanel(annotPanel, av);
     fm = g.getFontMetrics();
     AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
+    int temp = 0;
     if (aa==null)
     {
       return false;
@@ -280,6 +387,9 @@ public class AnnotationRenderer
     // 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];
@@ -293,6 +403,17 @@ 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.get(row.graphGroup)) {
@@ -455,7 +576,8 @@ public class AnnotationRenderer
                                     .equals(row_annotations[column - 1].displayCharacter) || (row_annotations[column].displayCharacter
                             .length() < 2 && row_annotations[column].secondaryStructure == ' ')))
             {
-              g.drawString(row_annotations[column].displayCharacter, x
+               g.drawString(row_annotations[column].displayCharacter
+                         , x
                       * charWidth + charOffset, y + iconOffset);
             }
             g.setFont(ofont);
@@ -464,42 +586,161 @@ public class AnnotationRenderer
         if (row.hasIcons)
         {
           char ss = validRes ? row_annotations[column].secondaryStructure
-                  : ' ';
-          if (ss == 'S')
+                  : '-';
+          
+          if (ss == '(')
           {
             // distinguish between forward/backward base-pairing
             if (row_annotations[column].displayCharacter.indexOf(')') > -1)
             {
-              ss = 's';
+            
+              ss = ')';
+              
             }
           }
+           if (ss == '[')
+          {
+            if ((row_annotations[column].displayCharacter.indexOf(']') > -1))
+            {
+                ss = ']';
+                
+                
+            }
+          }
+           if (ss == '{')
+           {
+             // distinguish between forward/backward base-pairing
+             if (row_annotations[column].displayCharacter.indexOf('}') > -1)
+             {
+               ss = '}';
+               
+               
+             }
+           }
+           if (ss == '<')
+           {
+             // distinguish between forward/backward base-pairing
+             if (row_annotations[column].displayCharacter.indexOf('<') > -1)
+             {
+               ss = '>';
+               
+               
+             }
+           }
+           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);
+              
+               
+             }
+           }
+
+           
           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 'H':
-                drawHelixAnnot(g, row_annotations, lastSSX, x, y,
-                        iconOffset, startRes, column, validRes, validEnd);
+              
+              case '$':
+                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);
+              case 'µ':
+                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);
+              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;
                 break;
-
+              case '{':
+              case '}':
+              case '[':
+              case ']':
+              case '>':
+              case '<':
+              case 'A':
+              case 'a':
+              case 'B':
+              case 'b':
+              case 'C':
+              case 'c':
+              case 'D':
+              case 'd':
+              case 'E':
+              case 'e':
+              case 'F':
+              case 'f':
+              case 'G':
+              case 'g':
+              case 'H':
+              case 'h':
+              case 'I':
+              case 'i':
+              case 'J':
+              case 'j':
+              case 'K':
+              case 'k':
+              case 'L':
+              case 'l':
+              case 'M':
+              case 'm':
+              case 'N':
+              case 'n':
+              case 'O':
+              case 'o':
+              case 'P':
+              case 'p':
+              case 'Q':
+              case 'q':
+              case 'R':
+              case 'r':
+              case 'S':
+              case 's':
+              case 'T':
+              case 't':
+              case 'U':
+              case 'u':
+              case 'V':
+              case 'v':
+              case 'W':
+              case 'w':
+              case 'X':
+              case 'x':
+              case 'Y':
+              case 'y':
+              case 'Z':
+              case 'z':
+                 
+                 Color nonCanColor= getNotCanonicalColor(lastSS);
+                 drawPseudoNode(g, nonCanColor, row_annotations, lastSSX, x, y, iconOffset, startRes,
+                          column, validRes, validEnd);
+                 temp=x;
+                 break;
               default:
                 g.setColor(Color.gray);
                 g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth)
                         - lastSSX, 2);
-
+                temp=x;
                 break;
               }
             }
@@ -545,23 +786,89 @@ public class AnnotationRenderer
       {
         switch (lastSS)
         {
-        case 'H':
-          drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
-                  startRes, column, validRes, validEnd);
+        case '$':
+          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);
+        case 'µ':
+          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;
+        case '{':
+        case '}':
+        case '[':
+        case ']':
+        case '>':
+        case '<':
+        case 'A':
+        case 'a':
+        case 'B':
+        case 'b':
+        case 'C':
+        case 'c':
+        case 'D':
+        case 'd':
+        case 'E':
+        case 'e':
+        case 'F':
+        case 'f':
+        case 'G':
+        case 'g':
+        case 'H':
+        case 'h':
+        case 'I':
+        case 'i':
+        case 'J':
+        case 'j':
+        case 'K':
+        case 'k':
+        case 'L':
+        case 'l':
+        case 'M':
+        case 'm':
+        case 'N':
+        case 'n':
+        case 'O':
+        case 'o':
+        case 'P':
+        case 'p':
+        case 'Q':
+        case 'q':
+        case 'R':
+        case 'r':
+        case 'T':
+        case 't':
+        case 'U':
+        case 'u':
+        case 'V':
+        case 'v':
+        case 'W':
+        case 'w':
+        case 'X':
+        case 'x':
+        case 'Y':
+        case 'y':
+        case 'Z':
+        case 'z':
+               //System.out.println(lastSS);
+               
+          Color nonCanColor = getNotCanonicalColor(lastSS);
+         drawPseudoNode(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);
+          drawGlyphLine(g, row_annotations, lastSSX, x, y, iconOffset, startRes,
+                  column, validRes, validEnd);
           break;
         }
       }
@@ -572,6 +879,7 @@ public class AnnotationRenderer
         {
           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++)
             {
@@ -584,6 +892,7 @@ public class AnnotationRenderer
               {
                 aa[gg].visible = false;
               }
+
               if (aa[gg].graphMax > groupmax)
               {
                 groupmax = aa[gg].graphMax;
@@ -598,8 +907,8 @@ 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);
               }
             }
 
@@ -607,17 +916,22 @@ public class AnnotationRenderer
           }
           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);
         }
       }
-
+    } else {
+      if (clipst && !clipend)
+      {
+        clipend = true;
+      }
+    }// end if_in_visible_region
       if (row.graph > 0 && row.hasText)
       {
         y += charHeight;
@@ -628,6 +942,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;
   }
 
@@ -638,18 +973,21 @@ public class AnnotationRenderer
   private final Color HELIX_COLOUR = Color.red;
 
   private final Color STEM_COLOUR = Color.blue;
+  
+  private  Color sdNOTCANONICAL_COLOUR;
 
-  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);
 
@@ -1019,4 +1357,135 @@ public class AnnotationRenderer
       x += charWidth;
     }
   }
+
+  
+  Color getNotCanonicalColor(char lastss)
+       {
+         switch (lastss)
+      {
+         case '{':  
+             case '}':
+                 return new Color(255,125,5);
+                
+             case '[':
+             case ']':
+                 return new Color(245,115,10);
+                
+             case '>':
+             case '<':
+                 return new Color(235,135,15);
+                 
+             case 'A':
+             case 'a':
+                 return new Color(225,105,20);
+               
+             case 'B':
+             case 'b':
+                 return new Color(215,145,30);
+                 
+             case 'C':
+             case 'c':
+                 return new Color(205,95,35);
+                
+             case 'D':
+             case 'd':
+                 return new Color(195,155,45);
+                 
+             case 'E':
+             case 'e':
+                 return new Color(185,85,55);
+                
+             case 'F':
+             case 'f':
+                 return new Color(175,165,65);
+                
+             case 'G':
+             case 'g':
+                 return new Color(170,75,75);
+               
+             case 'H':
+             case 'h':
+                 return new Color(160,175,85);
+                 
+             case 'I':
+             case 'i':
+                 return new Color(150,65,95);
+                
+             case 'J':
+             case 'j':
+                 return new Color(140,185,105);
+                 
+             case 'K':
+             case 'k':
+                 return new Color(130,55,110);
+               
+             case 'L':
+             case 'l':
+                 return new Color(120,195,120);
+       
+             case 'M':
+             case 'm':
+                 return new Color(110,45,130);
+               
+             case 'N':
+             case 'n':
+                 return new Color(100,205,140);
+                 
+             case 'O':
+             case 'o':
+                 return new Color(90,35,150);
+               
+             case 'P':
+             case 'p':
+                 return new Color(85,215,160);
+               
+             case 'Q':
+             case 'q':
+                 return new Color(75,25,170);
+       
+             case 'R':
+             case 'r':
+                 return new Color(65,225,180);
+       
+             case 'S':
+             case 's':
+                 return new Color(55,15,185);
+               
+             case 'T':
+             case 't':
+                 return new Color(45,235,195);
+                
+             case 'U':
+             case 'u':
+                 return new Color(35,5,205);
+                 
+             case 'V':
+             case 'v':
+                 return new Color(25,245,215);
+                
+             case 'W':
+             case 'w':
+                 return new Color(15,0,225);
+                 
+             case 'X':
+             case 'x':
+                 return new Color(10,255,235);
+                
+             case 'Y':
+             case 'y':
+                 return new Color(5,150,245);
+                 
+             case 'Z':
+             case 'z':
+                 return new Color(0,80,255);
+                
+       default :
+               System.out.println("This is not a interaction : "+lastss);
+               return null;
+               
+      }
+       }
 }
+
+       
+