src/jalview/viewmodel/OverviewDimensionsShowHidden.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.viewmodel;
  22
  23 import jalview.api.AlignmentColsCollectionI;
  24 import jalview.api.AlignmentRowsCollectionI;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.AllColsCollection;
  27 import jalview.datamodel.AllRowsCollection;
  28 import jalview.datamodel.HiddenColumns;
  29 import jalview.datamodel.HiddenSequences;
  30
  31 public class OverviewDimensionsShowHidden extends OverviewDimensions
  32 {
  33   private ViewportRanges ranges;
  34
  35   private int xdiff; // when dragging, difference in alignment units between
  36                      // start residue and original mouse click position
  37
  38   private int ydiff; // when dragging, difference in alignment units between
  39                      // start sequence and original mouse click position
  40
  41   /**
  42    * Create an OverviewDimensions object
  43    *
  44    * @param ranges
  45    *          positional properties of the viewport
  46    * @param showAnnotationPanel
  47    *          true if the annotation panel is to be shown, false otherwise
  48    */
  49   public OverviewDimensionsShowHidden(ViewportRanges vpranges,
  50           boolean showAnnotationPanel)
  51   {
  52     super(vpranges, showAnnotationPanel);
  53     ranges = vpranges;
  54     resetAlignmentDims();
  55   }
  56
  57   /**
  58    * Check box dimensions and scroll positions and correct if necessary
  59    *
  60    * @param mousex
  61    *          x position in overview panel
  62    * @param mousey
  63    *          y position in overview panel
  64    * @param hiddenSeqs
  65    *          hidden sequences
  66    * @param hiddenCols
  67    *          hidden columns
  68    * @param ranges
  69    *          viewport position properties
  70    */
  71   @Override
  72   public void updateViewportFromMouse(int mousex, int mousey,
  73           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
  74   {
  75     // convert mousex and mousey to alignment units as well as
  76     // translating to top left corner of viewport - this is an absolute position
  77     int xAsRes = getLeftXFromCentreX(mousex, hiddenCols);
  78     int yAsSeq = getTopYFromCentreY(mousey, hiddenSeqs);
  79
  80     // convert to visible positions
  81     int visXAsRes = hiddenCols.findColumnPosition(xAsRes);
  82     yAsSeq = hiddenSeqs.adjustForHiddenSeqs(
  83             hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq));
  84     yAsSeq = Math.max(yAsSeq, 0); // -1 if before first visible sequence
  85     int visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
  86     visYAsSeq = Math.max(visYAsSeq, 0); // -1 if before first visible sequence
  87
  88     // update viewport accordingly
  89     updateViewportFromTopLeft(visXAsRes, visYAsSeq, hiddenSeqs, hiddenCols);
  90   }
  91
  92   @Override
  93   public void adjustViewportFromMouse(int mousex, int mousey,
  94           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
  95   {
  96     // calculate translation in pixel terms:
  97     // get mouse location in viewport coords, add translation in viewport
  98     // coords,
  99     // convert back to pixel coords
 100     int vpx = Math.round((float) mousex * alwidth / width);
 101     int visXAsRes = hiddenCols.findColumnPosition(vpx) + xdiff;
 102
 103     int vpy = Math.round((float) mousey * alheight / sequencesHeight);
 104     int visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(vpy) + ydiff;
 105
 106     // update viewport accordingly
 107     updateViewportFromTopLeft(visXAsRes, visYAsRes,
 108             hiddenSeqs,
 109             hiddenCols);
 110   }
 111
 112   @Override
 113   protected void updateViewportFromTopLeft(int leftx, int topy,
 114           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
 115   {
 116     int visXAsRes = leftx;
 117     int visYAsSeq = topy;
 118     resetAlignmentDims();
 119
 120     if (visXAsRes < 0)
 121     {
 122       visXAsRes = 0;
 123     }
 124
 125     if (visYAsSeq < 0)
 126     {
 127       visYAsSeq = 0;
 128     }
 129
 130     if (ranges.isWrappedMode())
 131     {
 132       visYAsSeq = 0; // sorry, no vertical scroll when wrapped
 133     }
 134
 135     // Determine where scrollCol should be, given visXAsRes
 136
 137     // get viewport width in residues
 138     int vpwidth = ranges.getViewportWidth();
 139
 140     // check in case we went off the edge of the alignment
 141     int visAlignWidth = hiddenCols.findColumnPosition(alwidth - 1);
 142     if (visXAsRes + vpwidth - 1 > visAlignWidth)
 143     {
 144       // went past the end of the alignment, adjust backwards
 145
 146       // if last position was before the end of the alignment, need to update
 147       if (ranges.getEndRes() < visAlignWidth)
 148       {
 149         visXAsRes = hiddenCols.findColumnPosition(hiddenCols
 150                 .subtractVisibleColumns(vpwidth - 1, alwidth - 1));
 151       }
 152       else
 153       {
 154         visXAsRes = ranges.getStartRes();
 155       }
 156     }
 157
 158     // Determine where scrollRow should be, given visYAsSeq
 159
 160     // get viewport height in sequences
 161     int vpheight = ranges.getViewportHeight();
 162
 163     // check in case we went off the edge of the alignment
 164     int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight);
 165
 166     if (visYAsSeq + vpheight - 1 > visAlignHeight)
 167     {
 168       // went past the end of the alignment, adjust backwards
 169       if (ranges.getEndSeq() < visAlignHeight)
 170       {
 171         visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(hiddenSeqs
 172                 .subtractVisibleRows(vpheight - 1, alheight - 1));
 173       }
 174       else
 175       {
 176         visYAsSeq = ranges.getStartSeq();
 177       }
 178     }
 179
 180     // update viewport
 181     ranges.setStartRes(visXAsRes);
 182     ranges.setStartSeq(visYAsSeq);
 183   }
 184
 185   /**
 186    * Update the overview panel box when the associated alignment panel is
 187    * changed
 188    *
 189    * @param hiddenSeqs
 190    *          hidden sequences
 191    * @param hiddenCols
 192    *          hidden columns
 193    * @param ranges
 194    *          viewport position properties
 195    */
 196   @Override
 197   public void setBoxPosition(HiddenSequences hiddenSeqs,
 198           HiddenColumns hiddenCols)
 199   {
 200     // work with absolute values of startRes and endRes
 201     int startRes = hiddenCols.adjustForHiddenColumns(ranges.getStartRes());
 202     int endRes = hiddenCols.adjustForHiddenColumns(ranges.getEndRes());
 203
 204     // work with absolute values of startSeq and endSeq
 205     int startSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getStartSeq());
 206     int endSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getEndSeq());
 207
 208     setBoxPosition(startRes, startSeq, endRes - startRes + 1, endSeq
 209             - startSeq + 1);
 210   }
 211
 212   @Override
 213   public AlignmentColsCollectionI getColumns(AlignmentI al)
 214   {
 215     return new AllColsCollection(0,
 216             ranges.getAbsoluteAlignmentWidth() - 1, al);
 217   }
 218
 219   @Override
 220   public AlignmentRowsCollectionI getRows(AlignmentI al)
 221   {
 222     return new AllRowsCollection(0,
 223             ranges.getAbsoluteAlignmentHeight() - 1,
 224             al);
 225   }
 226
 227   @Override
 228   protected void resetAlignmentDims()
 229   {
 230     alwidth = ranges.getAbsoluteAlignmentWidth();
 231     alheight = ranges.getAbsoluteAlignmentHeight();
 232   }
 233
 234   @Override
 235   protected int getLeftXFromCentreX(int mousex, HiddenColumns hidden)
 236   {
 237     int vpx = Math.round((float) mousex * alwidth / width);
 238     return hidden.subtractVisibleColumns(ranges.getViewportWidth() / 2,
 239             vpx);
 240   }
 241
 242   @Override
 243   protected int getTopYFromCentreY(int mousey, HiddenSequences hidden)
 244   {
 245     int vpy = Math.round((float) mousey * alheight / sequencesHeight);
 246     return hidden.subtractVisibleRows(ranges.getViewportHeight() / 2, vpy);
 247   }
 248
 249   @Override
 250   public void setDragPoint(int x, int y, HiddenSequences hiddenSeqs,
 251           HiddenColumns hiddenCols)
 252   {
 253     // get alignment position of x and box (can get directly from vpranges) and
 254     // calculate difference between the positions
 255     int vpx = Math.round((float) x * alwidth / width);
 256     int vpy = Math.round((float) y * alheight / sequencesHeight);
 257
 258     xdiff = ranges.getStartRes() - hiddenCols.findColumnPosition(vpx);
 259     ydiff = ranges.getStartSeq()
 260             - hiddenSeqs.findIndexWithoutHiddenSeqs(vpy);
 261   }
 262
 263 }