Merge branch 'improvement/JAL-4250_secondary_structure_annotation_antialias' into...
authorBen Soares <b.soares@dundee.ac.uk>
Mon, 21 Aug 2023 11:16:07 +0000 (12:16 +0100)
committerBen Soares <b.soares@dundee.ac.uk>
Mon, 21 Aug 2023 11:16:07 +0000 (12:16 +0100)
src/jalview/renderer/AnnotationRenderer.java

index 65631e3..9a0081f 100644 (file)
@@ -27,6 +27,7 @@ import java.awt.FontMetrics;
 import java.awt.Graphics;
 import java.awt.Graphics2D;
 import java.awt.Image;
+import java.awt.RenderingHints;
 import java.awt.geom.AffineTransform;
 import java.awt.image.ImageObserver;
 import java.util.BitSet;
@@ -37,6 +38,8 @@ import jalview.analysis.CodingUtils;
 import jalview.analysis.Rna;
 import jalview.analysis.StructureFrequency;
 import jalview.api.AlignViewportI;
+import jalview.bin.Cache;
+import jalview.bin.Console;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.Annotation;
 import jalview.datamodel.ColumnSelection;
@@ -189,7 +192,7 @@ public class AnnotationRenderer
          * if new annotation with a closing base pair half of the stem, 
          * display a backward arrow
          */
-        g.fillPolygon(new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
+        fillPolygon(g, new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
                 new int[]
                 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset },
                 3);
@@ -209,7 +212,7 @@ public class AnnotationRenderer
          * if annotation ending with an opeing base pair half of the stem, 
          * display a forward arrow
          */
-        g.fillPolygon(new int[] { x2 - 5, x2 - 5, x2 },
+        fillPolygon(g, new int[] { x2 - 5, x2 - 5, x2 },
                 new int[]
                 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset },
                 3);
@@ -221,7 +224,7 @@ public class AnnotationRenderer
       }
     }
     // draw arrow body
-    g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 7);
+    fillRect(g, x1, y + 4 + iconOffset, x2 - x1, 7);
   }
 
   void drawNotCanonicalAnnot(Graphics g, Color nonCanColor,
@@ -229,9 +232,8 @@ public class AnnotationRenderer
           int iconOffset, int startRes, int column, boolean validRes,
           boolean validEnd)
   {
-    // jalview.bin.Console.outPrintln(nonCanColor);
+    // Console.info(nonCanColor);
 
-    g.setColor(nonCanColor);
     int sCol = (lastSSX / charWidth)
             + hiddenColumns.visibleToAbsoluteColumn(startRes);
     int x1 = lastSSX;
@@ -245,9 +247,17 @@ public class AnnotationRenderer
     boolean diffdownstream = !validRes || !validEnd
             || row_annotations[column] == null
             || !dc.equals(row_annotations[column].displayCharacter);
-    // jalview.bin.Console.outPrintln("Column "+column+" diff up: "+diffupstream+"
+    // Console.info("Column "+column+" diff up:
+    // "+diffupstream+"
     // down:"+diffdownstream);
     // If a closing base pair half of the stem, display a backward arrow
+    if (diffupstream || diffdownstream)
+    {
+      // draw glyphline under arrow
+      this.drawGlyphLine(g, row_annotations, lastSSX, x, y, iconOffset,
+              startRes, column, validRes, validEnd);
+    }
+    g.setColor(nonCanColor);
     if (column > 0 && Rna.isClosingParenthesis(dc))
     {
 
@@ -255,9 +265,10 @@ public class AnnotationRenderer
       // 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 },
+        fillPolygon(g, new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
                 new int[]
-                { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset },
+                { y + iconOffset + 1, y + 13 + iconOffset,
+                    y + 7 + iconOffset },
                 3);
         x1 += 5;
       }
@@ -272,9 +283,10 @@ public class AnnotationRenderer
       // display a forward arrow
       if (diffdownstream)
       {
-        g.fillPolygon(new int[] { x2 - 5, x2 - 5, x2 },
+        fillPolygon(g, new int[] { x2 - 6, x2 - 6, x2 - 1 },
                 new int[]
-                { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset },
+                { y + iconOffset + 1, y + 13 + iconOffset,
+                    y + 7 + iconOffset },
                 3);
         x2 -= 5;
       }
@@ -284,7 +296,8 @@ public class AnnotationRenderer
       }
     }
     // draw arrow body
-    g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 7);
+    unsetAntialias(g);
+    fillRect(g, x1 - 1, y + 4 + iconOffset, x2 - x1 + 1, 6);
   }
 
   // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI
@@ -447,6 +460,17 @@ public class AnnotationRenderer
           AlignViewportI av, Graphics g, int activeRow, int startRes,
           int endRes)
   {
+    Graphics2D g2d = (Graphics2D) g;
+    /*
+    if (Cache.getDefault("ANTI_ALIAS", true))
+    {
+      g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+              RenderingHints.VALUE_ANTIALIAS_ON);
+      g2d.setRenderingHint(RenderingHints.KEY_STROKE_CONTROL,
+              RenderingHints.VALUE_STROKE_PURE);
+    }
+    */
+
     long stime = System.currentTimeMillis();
     boolean usedFaded = false;
     // NOTES:
@@ -626,6 +650,7 @@ public class AnnotationRenderer
                   : null;
           if (x > -1)
           {
+            unsetAntialias(g);
             if (activeRow == i)
             {
               g.setColor(Color.red);
@@ -634,24 +659,24 @@ public class AnnotationRenderer
               {
                 if (columnSelection.contains(column))
                 {
-                  g.fillRect(x * charWidth, y, charWidth, charHeight);
+                  fillRect(g, x * charWidth, y, charWidth, charHeight);
                 }
               }
             }
             if (row.getInvalidStrucPos() > x)
             {
               g.setColor(Color.orange);
-              g.fillRect(x * charWidth, y, charWidth, charHeight);
+              fillRect(g, x * charWidth, y, charWidth, charHeight);
             }
             else if (row.getInvalidStrucPos() == x)
             {
               g.setColor(Color.orange.darker());
-              g.fillRect(x * charWidth, y, charWidth, charHeight);
+              fillRect(g, x * charWidth, y, charWidth, charHeight);
             }
             if (validCharWidth && validRes && displayChar != null
                     && (displayChar.length() > 0))
             {
-              Graphics2D gg = ((Graphics2D) g);
+              // Graphics2D gg = (g);
               float fmWidth = fm.charsWidth(displayChar.toCharArray(), 0,
                       displayChar.length());
 
@@ -674,11 +699,11 @@ public class AnnotationRenderer
 
               if (row_annotations[column].colour == null)
               {
-                gg.setColor(Color.black);
+                g2d.setColor(Color.black);
               }
               else
               {
-                gg.setColor(row_annotations[column].colour);
+                g2d.setColor(row_annotations[column].colour);
               }
 
               /*
@@ -691,19 +716,20 @@ public class AnnotationRenderer
               /*
                * translate to drawing position _before_ applying any scaling
                */
-              gg.translate(xPos, yPos);
+              g2d.translate(xPos, yPos);
               if (scaledToFit)
               {
                 /*
                  * use a scaling transform to make the label narrower
                  * (JalviewJS doesn't have Font.deriveFont(AffineTransform))
                  */
-                gg.transform(
+                g2d.transform(
                         AffineTransform.getScaleInstance(fmScaling, 1.0));
               }
+              setAntialias(g);
               if (column == 0 || row.graph > 0)
               {
-                gg.drawString(displayChar, 0, 0);
+                g2d.drawString(displayChar, 0, 0);
               }
               else if (row_annotations[column - 1] == null || (labelAllCols
                       || !displayChar.equals(
@@ -711,7 +737,7 @@ public class AnnotationRenderer
                       || (displayChar.length() < 2
                               && row_annotations[column].secondaryStructure == ' ')))
               {
-                gg.drawString(displayChar, 0, 0);
+                g2d.drawString(displayChar, 0, 0);
               }
               if (scaledToFit)
               {
@@ -719,10 +745,10 @@ public class AnnotationRenderer
                  * undo scaling before translating back 
                  * (restoring saved transform does NOT work in JS PDFGraphics!)
                  */
-                gg.transform(AffineTransform
+                g2d.transform(AffineTransform
                         .getScaleInstance(1D / fmScaling, 1.0));
               }
-              gg.translate(-xPos, -yPos);
+              g2d.translate(-xPos, -yPos);
             }
           }
           if (row.hasIcons)
@@ -784,7 +810,8 @@ public class AnnotationRenderer
               {
 
                 // int nb_annot = x - temp;
-                // jalview.bin.Console.outPrintln("\t type :"+lastSS+"\t x :"+x+"\t nbre
+                // Console.info("\t type :"+lastSS+"\t x
+                // :"+x+"\t nbre
                 // annot :"+nb_annot);
                 switch (lastSS)
                 {
@@ -878,9 +905,12 @@ public class AnnotationRenderer
                   // temp = x;
                   break;
                 default:
-                  g.setColor(Color.gray);
+                  unsetAntialias(g);
+                  g.setColor(GLYPHLINE_COLOR);
                   g.fillRect(lastSSX, y + 6 + iconOffset,
                           (x * charWidth) - lastSSX, 2);
+                  g.drawRect(lastSSX, y + 6 + iconOffset,
+                          (x * charWidth) - lastSSX - 1, 2);
                   // temp = x;
                   break;
                 }
@@ -1006,7 +1036,7 @@ public class AnnotationRenderer
           case 'y':
           case 'Z':
           case 'z':
-            // jalview.bin.Console.outPrintln(lastSS);
+            // Console.info(lastSS);
             Color nonCanColor = getNotCanonicalColor(lastSS);
             drawNotCanonicalAnnot(g, nonCanColor, row_annotations, lastSSX,
                     x, y, iconOffset, startRes, column, validRes, validEnd);
@@ -1091,7 +1121,7 @@ public class AnnotationRenderer
               }
               else
               {
-                jalview.bin.Console.errPrintln(
+                Console.warn(
                         "rendered with " + renderer.getClass().toString());
               }
             }
@@ -1122,17 +1152,15 @@ public class AnnotationRenderer
       {
         if (clipst)
         {
-          jalview.bin.Console.errPrintln(
-                  "Start clip at : " + yfrom + " (index " + f_i + ")");
+          Console.warn("Start clip at : " + yfrom + " (index " + f_i + ")");
         }
         if (clipend)
         {
-          jalview.bin.Console.errPrintln(
-                  "End clip at : " + yto + " (index " + f_to + ")");
+          Console.warn("End clip at : " + yto + " (index " + f_to + ")");
         }
       }
       ;
-      jalview.bin.Console.errPrintln("Annotation Rendering time:"
+      Console.warn("Annotation Rendering time:"
               + (System.currentTimeMillis() - stime));
     }
     ;
@@ -1142,7 +1170,7 @@ public class AnnotationRenderer
 
   public static final Color GLYPHLINE_COLOR = Color.gray;
 
-  public static final Color SHEET_COLOUR = Color.green;
+  public static final Color SHEET_COLOUR = Color.green.darker();
 
   public static final Color HELIX_COLOUR = Color.red;
 
@@ -1154,8 +1182,11 @@ public class AnnotationRenderer
           int y, int iconOffset, int startRes, int column, boolean validRes,
           boolean validEnd)
   {
+    unsetAntialias(g);
     g.setColor(GLYPHLINE_COLOR);
     g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth) - lastSSX, 2);
+    g.drawRect(lastSSX, y + 6 + iconOffset, (x * charWidth) - lastSSX - 1,
+            2);
   }
 
   void drawSheetAnnot(Graphics g, Annotation[] row,
@@ -1163,26 +1194,29 @@ public class AnnotationRenderer
           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
             || row[column].secondaryStructure != 'E')
     {
-      g.fillRect(lastSSX, y + 4 + iconOffset, (x * charWidth) - lastSSX - 4,
-              7);
-      g.fillPolygon(
+      // draw the glyphline underneath
+      drawGlyphLine(g, row, lastSSX, x, y, iconOffset, startRes, column,
+              validRes, validEnd);
+      g.setColor(SHEET_COLOUR);
+      fillRect(g, lastSSX, y + 4 + iconOffset,
+              (x * charWidth) - lastSSX - 4, 6);
+      fillPolygon(g,
               new int[]
-              { (x * charWidth) - 4, (x * charWidth) - 4, (x * charWidth) },
+              { (x * charWidth) - 6, (x * charWidth) - 6,
+                  (x * charWidth - 1) },
               new int[]
-              { y + iconOffset, y + 14 + iconOffset, y + 7 + iconOffset },
+              { y + iconOffset + 1, y + 13 + iconOffset,
+                  y + 7 + iconOffset },
               3);
     }
     else
     {
-      g.fillRect(lastSSX, y + 4 + iconOffset, (x + 1) * charWidth - lastSSX,
-              7);
+      g.setColor(SHEET_COLOUR);
+      fillRect(g, lastSSX, y + 4 + iconOffset, x * charWidth - lastSSX, 6);
     }
-
   }
 
   void drawHelixAnnot(Graphics g, Annotation[] row, int lastSSX, int x,
@@ -1196,12 +1230,14 @@ public class AnnotationRenderer
     int x1 = lastSSX;
     int x2 = (x * charWidth);
 
+    y--;
+
     if (USE_FILL_ROUND_RECT)
     {
       int ofs = charWidth / 2;
       // Off by 1 offset when drawing rects and ovals
       // to offscreen image on the MAC
-      g.fillRoundRect(lastSSX, y + 4 + iconOffset, x2 - x1, 8, 8, 8);
+      fillRoundRect(g, lastSSX, y + 4 + iconOffset, x2 - x1 - 1, 8, 8, 8);
       if (sCol == 0 || row[sCol - 1] == null
               || row[sCol - 1].secondaryStructure != 'H')
       {
@@ -1209,8 +1245,8 @@ public class AnnotationRenderer
       else
       {
         // g.setColor(Color.orange);
-        g.fillRoundRect(lastSSX, y + 4 + iconOffset, x2 - x1 - ofs + 1, 8,
-                0, 0);
+        fillRoundRect(g, lastSSX, y + 4 + iconOffset, x2 - x1 - ofs, 8, 0,
+                0);
       }
       if (!validRes || row[column] == null
               || row[column].secondaryStructure != 'H')
@@ -1220,8 +1256,8 @@ public class AnnotationRenderer
       else
       {
         // g.setColor(Color.magenta);
-        g.fillRoundRect(lastSSX + ofs, y + 4 + iconOffset,
-                x2 - x1 - ofs + 1, 8, 0, 0);
+        fillRoundRect(g, lastSSX + ofs, y + 4 + iconOffset, x2 - x1 - ofs,
+                8, 0, 0);
 
       }
 
@@ -1231,19 +1267,19 @@ public class AnnotationRenderer
     if (sCol == 0 || row[sCol - 1] == null
             || row[sCol - 1].secondaryStructure != 'H')
     {
-      g.fillArc(lastSSX, y + 4 + iconOffset, charWidth, 8, 90, 180);
+      fillArc(g, lastSSX, y + 4 + iconOffset, charWidth, 8, 90, 180);
       x1 += charWidth / 2;
     }
 
     if (!validRes || row[column] == null
             || row[column].secondaryStructure != 'H')
     {
-      g.fillArc((x * charWidth) - charWidth, y + 4 + iconOffset, charWidth,
-              8, 270, 180);
+      fillArc(g, (x * charWidth) - charWidth - 1, y + 4 + iconOffset,
+              charWidth, 8, 270, 180);
       x2 -= charWidth / 2;
     }
 
-    g.fillRect(x1, y + 4 + iconOffset, x2 - x1, 8);
+    fillRect(g, x1, y + 4 + iconOffset, x2 - x1, 8);
   }
 
   void drawLineGraph(Graphics g, AlignmentAnnotation _aa,
@@ -1279,6 +1315,7 @@ public class AnnotationRenderer
       y2 = y - (int) ((0 - min / range) * graphHeight);
     }
 
+    setAntialias(g);
     g.setColor(Color.gray);
     g.drawLine(x - charWidth, y2, (eRes - sRes + 1) * charWidth, y2);
 
@@ -1420,11 +1457,11 @@ public class AnnotationRenderer
       {
         if (y1 - y2 > 0)
         {
-          g.fillRect(x * charWidth, y2, charWidth, y1 - y2);
+          fillRect(g, x * charWidth, y2, charWidth, y1 - y2);
         }
         else
         {
-          g.fillRect(x * charWidth, y1, charWidth, y2 - y1);
+          fillRect(g, x * charWidth, y1, charWidth, y2 - y1);
         }
       }
       // draw profile if available
@@ -1455,7 +1492,8 @@ public class AnnotationRenderer
           // lm is not necessary - we can just use fm - could be off by no more
           // than 0.5 px
           // LineMetrics lm = g.getFontMetrics(ofont).getLineMetrics("Q", g);
-          // jalview.bin.Console.outPrintln(asc + " " + dec + " " + (asc - lm.getAscent())
+          // Console.info(asc + " " + dec + " " + (asc -
+          // lm.getAscent())
           // + " " + (dec - lm.getDescent()));
 
           double asc = fm.getAscent();
@@ -1598,7 +1636,7 @@ public class AnnotationRenderer
   {
     eRes = Math.min(eRes, aa_annotations.length);
     g.setColor(Color.white);
-    g.fillRect(0, 0, width, y);
+    fillRect(g, 0, 0, width, y);
     g.setColor(new Color(0, 0, 180));
 
     int x = 0, height;
@@ -1622,7 +1660,7 @@ public class AnnotationRenderer
           height = y;
         }
 
-        g.fillRect(x, y - height, charWidth, height);
+        fillRect(g, x, y - height, charWidth, height);
       }
       x += charWidth;
     }
@@ -1749,9 +1787,58 @@ public class AnnotationRenderer
       return new Color(0, 80, 255);
 
     default:
-      jalview.bin.Console.outPrintln("This is not a interaction : " + lastss);
+      Console.info("This is not a interaction : " + lastss);
       return null;
 
     }
   }
+
+  private static void fillPolygon(Graphics g, int[] xpoints, int[] ypoints,
+          int n)
+  {
+    unsetAntialias(g);
+    g.fillPolygon(xpoints, ypoints, n);
+    setAntialias(g);
+    g.fillPolygon(xpoints, ypoints, n);
+    g.drawPolygon(xpoints, ypoints, n);
+  }
+
+  private static void fillRect(Graphics g, int a, int b, int c, int d)
+  {
+    g.fillRect(a, b, c, d);
+    g.drawRect(a, b, c, d);
+  }
+
+  private static void fillRoundRect(Graphics g, int a, int b, int c, int d,
+          int e, int f)
+  {
+    setAntialias(g);
+    g.fillRoundRect(a, b, c, d, e, f);
+    g.drawRoundRect(a, b, c, d, e, f);
+  }
+
+  private static void fillArc(Graphics g, int a, int b, int c, int d, int e,
+          int f)
+  {
+    setAntialias(g);
+    g.fillArc(a, b, c, d, e, f);
+    g.drawArc(a, b, c, d, e, f);
+  }
+
+  private static void setAntialias(Graphics g)
+  {
+    if (Cache.getDefault("ANTI_ALIAS", true))
+    {
+      Graphics2D g2d = (Graphics2D) g;
+      g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+              RenderingHints.VALUE_ANTIALIAS_ON);
+    }
+  }
+
+  private static void unsetAntialias(Graphics g)
+  {
+    Graphics2D g2d = (Graphics2D) g;
+    g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
+            RenderingHints.VALUE_ANTIALIAS_OFF);
+  }
 }