JAL-3675 release notes for JAL-3750 JAL-3751

[jalview.git] / src / jalview / renderer / ScaleRenderer.java

diff --git a/src/jalview/renderer/ScaleRenderer.java b/src/jalview/renderer/ScaleRenderer.java
index 7f1e074..dc3272f 100644 (file)
--- a/src/jalview/renderer/ScaleRenderer.java
+++ b/src/jalview/renderer/ScaleRenderer.java
@@ -21,9 +21,11 @@
 package jalview.renderer;
 
 import jalview.api.AlignViewportI;
+import jalview.datamodel.HiddenColumns;
 import jalview.datamodel.SequenceI;
 
 import java.util.ArrayList;
+import java.util.Iterator;
 import java.util.List;
 
 /**
@@ -35,6 +37,34 @@ import java.util.List;
 public class ScaleRenderer
 {
   /**
+   * Represents one major or minor scale mark
+   */
+  public final class ScaleMark
+  {
+    /**
+     * true for a major scale mark, false for minor
+     */
+    public final boolean major;
+
+    /**
+     * visible column position (0..) e.g. 19
+     */
+    public final int column;
+
+    /**
+     * text (if any) to show e.g. "20"
+     */
+    public final String text;
+
+    ScaleMark(boolean isMajor, int col, String txt)
+    {
+      major = isMajor;
+      column = col;
+      text = txt;
+    }
+  }
+
+  /**
    * calculate positions markers on the alignment ruler
    * 
    * @param av
@@ -42,29 +72,37 @@ public class ScaleRenderer
    *          left-most column in visible view
    * @param endx
    *          - right-most column in visible view
-   * @return List { Object { .. } } Boolean: true/false for major/minor mark,
-   *         Integer: marker position in alignment column coords, String: null
-   *         or a String to be rendered at the position.
+   * @return List of ScaleMark holding boolean: true/false for major/minor mark,
+   *         marker position in alignment column coords, a String to be rendered
+   *         at the position (or null)
    */
-  public static List<Object[]> calculateMarks(AlignViewportI av,
-          int startx, int endx)
+  public List<ScaleMark> calculateMarks(AlignViewportI av, int startx,
+          int endx)
   {
-    new ArrayList<Object[]>();
-
     int scalestartx = (startx / 10) * 10;
 
     SequenceI refSeq = av.getAlignment().getSeqrep();
-    int refSp = 0, refStartI = 0, refEndI = -1;
+    int refSp = 0;
+    int refStartI = 0;
+    int refEndI = -1;
+
+    HiddenColumns hc = av.getAlignment().getHiddenColumns();
+
     if (refSeq != null)
     {
-      // find bounds and set origin appopriately
-      // locate first visible position for this sequence
-      int[] refbounds = av.getColumnSelection()
-              .locateVisibleBoundsOfSequence(refSeq);
+      // find bounds and set origin appropriately
+      // locate first residue in sequence which is not hidden
+      Iterator<int[]> it = hc.iterator();
+      int index = refSeq.firstResidueOutsideIterator(it);
+      refSp = hc.absoluteToVisibleColumn(index);
+
+      refStartI = refSeq.findIndex(refSeq.getStart()) - 1;
+
+      int seqlength = refSeq.getLength();
+      // get sequence position past the end of the sequence
+      int pastEndPos = refSeq.findPosition(seqlength + 1);
+      refEndI = refSeq.findIndex(pastEndPos - 1) - 1;
 
-      refSp = refbounds[0];
-      refStartI = refbounds[4];
-      refEndI = refbounds[5];
       scalestartx = refSp + ((scalestartx - refSp) / 10) * 10;
     }
 
@@ -72,23 +110,22 @@ public class ScaleRenderer
     {
       scalestartx += 5;
     }
-    List<Object[]> marks = new ArrayList<Object[]>();
+    List<ScaleMark> marks = new ArrayList<>();
     String string;
     int refN, iadj;
     // todo: add a 'reference origin column' to set column number relative to
-    for (int i = scalestartx; i < endx; i += 5)
+    for (int i = scalestartx; i <= endx; i += 5)
     {
-      Object[] amark = new Object[3];
       if (((i - refSp) % 10) == 0)
       {
         if (refSeq == null)
         {
-          iadj = av.getColumnSelection().adjustForHiddenColumns(i - 1) + 1;
+          iadj = hc.visibleToAbsoluteColumn(i - 1) + 1;
           string = String.valueOf(iadj);
         }
         else
         {
-          iadj = av.getColumnSelection().adjustForHiddenColumns(i - 1);
+          iadj = hc.visibleToAbsoluteColumn(i - 1);
           refN = refSeq.findPosition(iadj);
           // TODO show bounds if position is a gap
           // - ie L--R -> "1L|2R" for
@@ -106,18 +143,12 @@ public class ScaleRenderer
             string = String.valueOf(refN) + refSeq.getCharAt(iadj);
           }
         }
-        amark[0] = Boolean.TRUE;
-        amark[1] = Integer.valueOf(i - startx - 1);
-        amark[2] = string;
-
+        marks.add(new ScaleMark(true, i - startx - 1, string));
       }
       else
       {
-        amark[0] = Boolean.FALSE;
-        amark[1] = Integer.valueOf(i - startx - 1);
-        amark[2] = null;
+        marks.add(new ScaleMark(false, i - startx - 1, null));
       }
-      marks.add(amark);
     }
     return marks;
   }