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, hiddenSeqs, hiddenCols);
 108   }
 109
 110   @Override
 111   protected void updateViewportFromTopLeft(int leftx, int topy,
 112           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
 113   {
 114     int visXAsRes = leftx;
 115     int visYAsSeq = topy;
 116     resetAlignmentDims();
 117
 118     if (visXAsRes < 0)
 119     {
 120       visXAsRes = 0;
 121     }
 122
 123     if (visYAsSeq < 0)
 124     {
 125       visYAsSeq = 0;
 126     }
 127
 128     if (ranges.isWrappedMode())
 129     {
 130       visYAsSeq = 0; // sorry, no vertical scroll when wrapped
 131     }
 132
 133     // Determine where scrollCol should be, given visXAsRes
 134
 135     // get viewport width in residues
 136     int vpwidth = ranges.getViewportWidth();
 137
 138     // check in case we went off the edge of the alignment
 139     int visAlignWidth = hiddenCols.findColumnPosition(alwidth - 1);
 140     if (visXAsRes + vpwidth - 1 > visAlignWidth)
 141     {
 142       // went past the end of the alignment, adjust backwards
 143
 144       // if last position was before the end of the alignment, need to update
 145       if (ranges.getEndRes() < visAlignWidth)
 146       {
 147         visXAsRes = hiddenCols.findColumnPosition(hiddenCols
 148                 .subtractVisibleColumns(vpwidth - 1, alwidth - 1));
 149       }
 150       else
 151       {
 152         visXAsRes = ranges.getStartRes();
 153       }
 154     }
 155
 156     // Determine where scrollRow should be, given visYAsSeq
 157
 158     // get viewport height in sequences
 159     int vpheight = ranges.getViewportHeight();
 160
 161     // check in case we went off the edge of the alignment
 162     int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight);
 163
 164     if (visYAsSeq + vpheight - 1 > visAlignHeight)
 165     {
 166       // went past the end of the alignment, adjust backwards
 167       if (ranges.getEndSeq() < visAlignHeight)
 168       {
 169         visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(
 170                 hiddenSeqs.subtractVisibleRows(vpheight - 1, alheight - 1));
 171       }
 172       else
 173       {
 174         visYAsSeq = ranges.getStartSeq();
 175       }
 176     }
 177
 178     // update viewport
 179     ranges.setStartRes(visXAsRes);
 180     ranges.setStartSeq(visYAsSeq);
 181   }
 182
 183   /**
 184    * Update the overview panel box when the associated alignment panel is
 185    * changed
 186    *
 187    * @param hiddenSeqs
 188    *          hidden sequences
 189    * @param hiddenCols
 190    *          hidden columns
 191    * @param ranges
 192    *          viewport position properties
 193    */
 194   @Override
 195   public void setBoxPosition(HiddenSequences hiddenSeqs,
 196           HiddenColumns hiddenCols)
 197   {
 198     // work with absolute values of startRes and endRes
 199     int startRes = hiddenCols.adjustForHiddenColumns(ranges.getStartRes());
 200     int endRes = hiddenCols.adjustForHiddenColumns(ranges.getEndRes());
 201
 202     // work with absolute values of startSeq and endSeq
 203     int startSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getStartSeq());
 204     int endSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getEndSeq());
 205
 206     setBoxPosition(startRes, startSeq, endRes - startRes + 1,
 207             endSeq - startSeq + 1);
 208   }
 209
 210   @Override
 211   public AlignmentColsCollectionI getColumns(AlignmentI al)
 212   {
 213     return new AllColsCollection(0, ranges.getAbsoluteAlignmentWidth() - 1,
 214             al);
 215   }
 216
 217   @Override
 218   public AlignmentRowsCollectionI getRows(AlignmentI al)
 219   {
 220     return new AllRowsCollection(0, ranges.getAbsoluteAlignmentHeight() - 1,
 221             al);
 222   }
 223
 224   @Override
 225   protected void resetAlignmentDims()
 226   {
 227     alwidth = ranges.getAbsoluteAlignmentWidth();
 228     alheight = ranges.getAbsoluteAlignmentHeight();
 229   }
 230
 231   @Override
 232   protected int getLeftXFromCentreX(int mousex, HiddenColumns hidden)
 233   {
 234     int vpx = Math.round((float) mousex * alwidth / width);
 235     return hidden.subtractVisibleColumns(ranges.getViewportWidth() / 2,
 236             vpx);
 237   }
 238
 239   @Override
 240   protected int getTopYFromCentreY(int mousey, HiddenSequences hidden)
 241   {
 242     int vpy = Math.round((float) mousey * alheight / sequencesHeight);
 243     return hidden.subtractVisibleRows(ranges.getViewportHeight() / 2, vpy);
 244   }
 245
 246   @Override
 247   public void setDragPoint(int x, int y, HiddenSequences hiddenSeqs,
 248           HiddenColumns hiddenCols)
 249   {
 250     // get alignment position of x and box (can get directly from vpranges) and
 251     // calculate difference between the positions
 252     int vpx = Math.round((float) x * alwidth / width);
 253     int vpy = Math.round((float) y * alheight / sequencesHeight);
 254
 255     xdiff = ranges.getStartRes() - hiddenCols.findColumnPosition(vpx);
 256     ydiff = ranges.getStartSeq()
 257             - hiddenSeqs.findIndexWithoutHiddenSeqs(vpy);
 258   }
 259
 260 }