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   /**
  36    * Create an OverviewDimensions object
  37    *
  38    * @param ranges
  39    *          positional properties of the viewport
  40    * @param showAnnotationPanel
  41    *          true if the annotation panel is to be shown, false otherwise
  42    */
  43   public OverviewDimensionsShowHidden(ViewportRanges vpranges,
  44           boolean showAnnotationPanel)
  45   {
  46     super(vpranges, showAnnotationPanel);
  47     ranges = vpranges;
  48     resetAlignmentDims();
  49   }
  50
  51   /**
  52    * Check box dimensions and scroll positions and correct if necessary
  53    *
  54    * @param mousex
  55    *          x position in overview panel
  56    * @param mousey
  57    *          y position in overview panel
  58    * @param hiddenSeqs
  59    *          hidden sequences
  60    * @param hiddenCols
  61    *          hidden columns
  62    * @param ranges
  63    *          viewport position properties
  64    */
  65   @Override
  66   public void updateViewportFromMouse(int mousex, int mousey,
  67           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
  68   {
  69     int xAsRes = getLeftXFromCentreX(mousex, hiddenCols);
  70     int yAsSeq = getTopYFromCentreY(mousey, hiddenSeqs);
  71
  72     updateViewportFromTopLeft(xAsRes, yAsSeq, hiddenSeqs, hiddenCols);
  73   }
  74
  75   @Override
  76   public void adjustViewportFromMouse(int mousex, int mousey,
  77           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
  78   {
  79     // calculate translation in pixel terms:
  80     // get mouse location in viewport coords, add translation in viewport
  81     // coords,
  82     // convert back to pixel coords
  83     int vpx = Math.round((float) mousex * alwidth / width);
  84     int visXAsRes = hiddenCols.findColumnPosition(vpx);
  85
  86     int vpy = Math.round((float) mousey * alheight / sequencesHeight);
  87     int visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(vpy);
  88
  89     updateViewportFromTopLeft(visXAsRes + transX, visYAsRes + transY,
  90             hiddenSeqs,
  91             hiddenCols);
  92   }
  93
  94   @Override
  95   protected void updateViewportFromTopLeft(int xAsRes, int yAsSeq,
  96           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols)
  97   {
  98
  99     resetAlignmentDims();
 100
 101     if (xAsRes < 0)
 102     {
 103       xAsRes = 0;
 104     }
 105
 106     if (yAsSeq < 0)
 107     {
 108       yAsSeq = 0;
 109     }
 110
 111     //
 112     // Convert x value to residue position
 113     //
 114
 115     // need to determine where scrollCol should be, given x
 116     // to do this also need to know width of viewport, and some hidden column
 117     // correction
 118
 119     // convert x to residues - this is an absolute position
 120     // int xAsRes = Math.round((float) x * alwidth / width);
 121
 122     // get viewport width in residues
 123     int vpwidth = ranges.getViewportWidth();
 124
 125     // get where x should be when accounting for hidden cols
 126     // if x is in a hidden col region, shift to left - but we still need
 127     // absolute position
 128     // so convert back after getting visible region position
 129     int visXAsRes = hiddenCols.findColumnPosition(xAsRes);
 130
 131     // check in case we went off the edge of the alignment
 132     int visAlignWidth = hiddenCols.findColumnPosition(alwidth - 1);
 133     if (visXAsRes + vpwidth - 1 > visAlignWidth)
 134     {
 135       // went past the end of the alignment, adjust backwards
 136
 137       // if last position was before the end of the alignment, need to update
 138       if (ranges.getEndRes() < visAlignWidth)
 139       {
 140         visXAsRes = hiddenCols.findColumnPosition(hiddenCols
 141                 .subtractVisibleColumns(vpwidth - 1, alwidth - 1));
 142       }
 143       else
 144       {
 145         visXAsRes = ranges.getStartRes();
 146       }
 147     }
 148
 149     //
 150     // Convert y value to sequence position
 151     //
 152
 153     // convert y to residues
 154     // int yAsSeq = Math.round((float) y * alheight / sequencesHeight);
 155
 156     // get viewport height in sequences
 157     int vpheight = ranges.getViewportHeight();
 158
 159     // get where y should be when accounting for hidden rows
 160     // if y is in a hidden row region, shift up - but we still need absolute
 161     // position,
 162     // so convert back after getting visible region position
 163     yAsSeq = hiddenSeqs.adjustForHiddenSeqs(hiddenSeqs
 164             .findIndexWithoutHiddenSeqs(yAsSeq));
 165
 166     // check in case we went off the edge of the alignment
 167     int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight);
 168     int visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
 169     if (visYAsSeq + vpheight - 1 > visAlignHeight)
 170     {
 171       // went past the end of the alignment, adjust backwards
 172       if (ranges.getEndSeq() < visAlignHeight)
 173       {
 174         visYAsSeq = hiddenSeqs.findIndexWithoutHiddenSeqs(hiddenSeqs
 175                 .subtractVisibleRows(vpheight - 1, alheight - 1));
 176       }
 177       else
 178       {
 179         visYAsSeq = ranges.getStartSeq();
 180       }
 181     }
 182
 183     // update viewport
 184     ranges.setStartRes(visXAsRes);
 185     ranges.setStartSeq(visYAsSeq);
 186
 187   }
 188
 189   /**
 190    * Update the overview panel box when the associated alignment panel is
 191    * changed
 192    *
 193    * @param hiddenSeqs
 194    *          hidden sequences
 195    * @param hiddenCols
 196    *          hidden columns
 197    * @param ranges
 198    *          viewport position properties
 199    */
 200   @Override
 201   public void setBoxPosition(HiddenSequences hiddenSeqs,
 202           HiddenColumns hiddenCols)
 203   {
 204
 205     // work with absolute values of startRes and endRes
 206     int startRes = hiddenCols.adjustForHiddenColumns(ranges.getStartRes());
 207     int endRes = hiddenCols.adjustForHiddenColumns(ranges.getEndRes());
 208
 209     // work with absolute values of startSeq and endSeq
 210     int startSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getStartSeq());
 211     int endSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getEndSeq());
 212
 213     setBoxPosition(startRes, startSeq, endRes - startRes + 1, endSeq
 214             - startSeq + 1);
 215   }
 216
 217   @Override
 218   public AlignmentColsCollectionI getColumns(AlignmentI al)
 219   {
 220     return new AllColsCollection(0,
 221             ranges.getAbsoluteAlignmentWidth() - 1, al);
 222   }
 223
 224   @Override
 225   public AlignmentRowsCollectionI getRows(AlignmentI al)
 226   {
 227     return new AllRowsCollection(0,
 228             ranges.getAbsoluteAlignmentHeight() - 1,
 229             al);
 230   }
 231
 232   @Override
 233   protected void resetAlignmentDims()
 234   {
 235     alwidth = ranges.getAbsoluteAlignmentWidth();
 236     alheight = ranges.getAbsoluteAlignmentHeight();
 237   }
 238
 239   @Override
 240   protected int getLeftXFromCentreX(int mousex, HiddenColumns hidden)
 241   {
 242     int vpx = Math.round((float) mousex * alwidth / width);
 243     return hidden.subtractVisibleColumns(ranges.getViewportWidth() / 2,
 244             vpx);
 245   }
 246
 247   @Override
 248   protected int getTopYFromCentreY(int mousey, HiddenSequences hidden)
 249   {
 250     int vpy = Math.round((float) mousey * alheight / sequencesHeight);
 251     return hidden.subtractVisibleRows(ranges.getViewportHeight() / 2, vpy);
 252   }
 253
 254   @Override
 255   public void setDragPoint(int x, int y, HiddenSequences hiddenSeqs,
 256           HiddenColumns hiddenCols)
 257   {
 258     {
 259       // get alignment position of x and box (can get directly from vpranges) and calc difference
 260       int vpx = Math.round((float) x * alwidth / width);
 261       int visXAsRes = hiddenCols.findColumnPosition(vpx);
 262
 263       int vpy = Math.round((float) y * alheight / sequencesHeight);
 264       int visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(vpy);
 265
 266       transX = ranges.getStartRes() - visXAsRes;
 267       transY = ranges.getStartSeq() - visYAsRes;
 268     }
 269   }
 270
 271 }