src/jalview/viewmodel/OverviewDimensions.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.datamodel.ColumnSelection;
  24 import jalview.datamodel.HiddenSequences;
  25
  26 import java.awt.Graphics;
  27
  28 public class OverviewDimensions
  29 {
  30   // Default width and height values
  31   private static final int DEFAULT_GRAPH_HEIGHT = 20;
  32
  33   private static final int MAX_WIDTH = 400;
  34
  35   private static final int MIN_WIDTH = 120;
  36
  37   private static final int MIN_SEQ_HEIGHT = 40;
  38
  39   private static final int MAX_SEQ_HEIGHT = 300;
  40
  41   // width of the overview panel
  42   private int width;
  43
  44   // height of sequences part of the overview panel
  45   private int sequencesHeight;
  46
  47   // height of the graphs part of the overview panel
  48   private int graphHeight = DEFAULT_GRAPH_HEIGHT;
  49
  50   // dimensions of box outlining current extent of view in alignment panel
  51   // location of left side of box
  52   private int boxX = -1;
  53
  54   // location of bottom of box
  55   private int boxY = -1;
  56
  57   // width of box
  58   private int boxWidth = -1;
  59
  60   // height of box
  61   private int boxHeight = -1;
  62
  63   // scroll position in viewport corresponding to boxX
  64   private int scrollCol = -1;
  65
  66   // scroll position in viewport corresponding to boxY
  67   private int scrollRow = -1;
  68
  69   /**
  70    * Create an OverviewDimensions object
  71    *
  72    * @param props
  73    *          positional properties of the viewport
  74    * @param showAnnotationPanel
  75    *          true if the annotation panel is to be shown, false otherwise
  76    */
  77   public OverviewDimensions(ViewportPositionProps props,
  78           boolean showAnnotationPanel)
  79   {
  80     // scale the initial size of overviewpanel to shape of alignment
  81     float initialScale = (float) props.getAbsoluteAlignmentWidth()
  82             / (float) props.getAbsoluteAlignmentHeight();
  83
  84     if (!showAnnotationPanel)
  85     {
  86       graphHeight = 0;
  87     }
  88
  89     if (props.getAbsoluteAlignmentWidth() > props
  90             .getAbsoluteAlignmentHeight())
  91     {
  92       // wider
  93       width = MAX_WIDTH;
  94       sequencesHeight = (int) (MAX_WIDTH / initialScale);
  95       if (sequencesHeight < MIN_SEQ_HEIGHT)
  96       {
  97         sequencesHeight = MIN_SEQ_HEIGHT;
  98       }
  99     }
 100     else
 101     {
 102       // taller
 103       width = (int) (MAX_WIDTH * initialScale);
 104       sequencesHeight = MAX_SEQ_HEIGHT;
 105
 106       if (width < MIN_WIDTH)
 107       {
 108         width = MIN_WIDTH;
 109       }
 110     }
 111   }
 112
 113   /**
 114    * Check box dimensions and scroll positions and correct if necessary
 115    *
 116    * @param mousex
 117    *          x position in overview panel
 118    * @param mousey
 119    *          y position in overview panel
 120    * @param hiddenSeqs
 121    *          hidden sequences
 122    * @param hiddenCols
 123    *          hidden columns
 124    * @param props
 125    *          viewport position properties
 126    */
 127   public void updateViewportFromMouse(int mousex, int mousey,
 128           HiddenSequences hiddenSeqs, ColumnSelection hiddenCols,
 129           ViewportPositionProps props)
 130   {
 131     int x = mousex;
 132     int y = mousey;
 133
 134     int alwidth = props.getAbsoluteAlignmentWidth();
 135     int alheight = props.getAbsoluteAlignmentHeight();
 136
 137     if (x < 0)
 138     {
 139       x = 0;
 140     }
 141
 142     if (y < 0)
 143     {
 144       y = 0;
 145     }
 146
 147     //
 148     // Convert x value to residue position
 149     //
 150
 151     // need to determine where scrollCol should be, given x
 152     // to do this also need to know width of viewport, and some hidden column
 153     // correction
 154
 155     // convert x to residues - this is an absolute position
 156     int xAsRes = Math.round((float) x * alwidth / width);
 157
 158     // get viewport width in residues
 159     int vpwidth = props.getEndRes() - props.getStartRes() + 1;
 160
 161     // get where x should be when accounting for hidden cols
 162     // if x is in a hidden col region, shift to left - but we still need
 163     // absolute position
 164     // so convert back after getting visible region position
 165     int visXAsRes = hiddenCols.findColumnPosition(xAsRes);
 166
 167     // check in case we went off the edge of the alignment
 168     int visAlignWidth = hiddenCols.findColumnPosition(alwidth - 1);
 169     if (visXAsRes + vpwidth - 1 > visAlignWidth)
 170     {
 171       // went past the end of the alignment, adjust backwards
 172
 173       // if last position was before the end of the alignment, need to update
 174       if ((scrollCol + vpwidth - 1) < visAlignWidth)
 175       {
 176         visXAsRes = hiddenCols.findColumnNToLeft(vpwidth - 1, alwidth - 1);
 177       }
 178       else
 179       {
 180         visXAsRes = scrollCol;
 181       }
 182     }
 183
 184     //
 185     // Convert y value to sequence position
 186     //
 187
 188     // convert y to residues
 189     int yAsSeq = Math.round((float) y * alheight / sequencesHeight);
 190
 191     // get viewport height in sequences
 192     // add 1 because height includes both endSeq and startSeq
 193     int vpheight = props.getEndSeq() - props.getStartSeq() + 1;
 194
 195     // get where y should be when accounting for hidden rows
 196     // if y is in a hidden row region, shift up - but we still need absolute
 197     // position,
 198     // so convert back after getting visible region position
 199     yAsSeq = hiddenSeqs.adjustForHiddenSeqs(hiddenSeqs
 200             .findIndexWithoutHiddenSeqs(yAsSeq));
 201
 202     // get where end seq should be by adding the viewport height on
 203     int endSeq = yAsSeq + vpheight - 1;
 204
 205     // check in case we went off the edge of the alignment
 206     int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight);
 207     int visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
 208     if (hiddenSeqs.findIndexWithoutHiddenSeqs(endSeq) > visAlignHeight)
 209     {
 210       // went past the end of the alignment, adjust backwards
 211       if ((scrollRow + vpheight - 1) < visAlignHeight)
 212       {
 213         visYAsRes = hiddenSeqs
 214                 .findIndexNAboveRow(vpheight - 1, alheight - 1);
 215       }
 216       else
 217       {
 218         visYAsRes = scrollRow;
 219       }
 220     }
 221
 222     // convert absolute positions back to visible alignment positions for
 223     // viewport scrolling
 224     scrollCol = visXAsRes;
 225     scrollRow = visYAsRes; // hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
 226
 227   }
 228
 229   /**
 230    * Update the overview panel box when the associated alignment panel is
 231    * changed
 232    *
 233    * @param hiddenSeqs
 234    *          hidden sequences
 235    * @param hiddenCols
 236    *          hidden columns
 237    * @param props
 238    *          viewport position properties
 239    */
 240   public void setBoxPosition(HiddenSequences hiddenSeqs,
 241           ColumnSelection hiddenCols, ViewportPositionProps props)
 242   {
 243     int alwidth = props.getAbsoluteAlignmentWidth();
 244     int alheight = props.getAbsoluteAlignmentHeight();
 245
 246     // work with absolute values of startRes and endRes
 247     int startRes = hiddenCols.adjustForHiddenColumns(props.getStartRes());
 248     int endRes = hiddenCols.adjustForHiddenColumns(props.getEndRes());
 249
 250     // work with absolute values of startSeq and endSeq
 251     int startSeq = hiddenSeqs.adjustForHiddenSeqs(props.getStartSeq());
 252     int endSeq = hiddenSeqs.adjustForHiddenSeqs(props.getEndSeq());
 253
 254     // boxX, boxY is the x,y location equivalent to startRes, startSeq
 255     boxX = Math.round((float) startRes * width / alwidth);
 256     boxY = Math.round((float) startSeq * sequencesHeight / alheight);
 257
 258     // boxWidth is the width in residues translated to pixels
 259     // since the box includes both the start and end residues, add 1 to the
 260     // difference
 261     boxWidth = Math
 262             .round((float) (endRes - startRes + 1) * width / alwidth);
 263     // boxHeight is the height in sequences translated to pixels
 264     boxHeight = Math.round((float) (endSeq - startSeq + 1)
 265             * sequencesHeight
 266             / alheight);
 267   }
 268
 269   /**
 270    * Draw the overview panel's viewport box on a graphics object
 271    *
 272    * @param g
 273    *          the graphics object to draw on
 274    */
 275   public void drawBox(Graphics g)
 276   {
 277     g.drawRect(boxX, boxY, boxWidth, boxHeight);
 278     g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);
 279   }
 280
 281   // don't like this, scroll vals are separate from setting code
 282   public int getScrollCol()
 283   {
 284     return scrollCol;
 285   }
 286
 287   public int getScrollRow()
 288   {
 289     return scrollRow;
 290   }
 291
 292   // TODO should be removed, when unit test has mock Graphics object available
 293   // to check boxX/boxY
 294   public int getBoxX()
 295   {
 296     return boxX;
 297   }
 298
 299   // TODO should be removed, when unit test has mock Graphics object available
 300   // to check boxX/boxY
 301   public int getBoxY()
 302   {
 303     return boxY;
 304   }
 305
 306   // TODO should be removed, when unit test has mock Graphics object available
 307   public int getBoxWidth()
 308   {
 309     return boxWidth;
 310   }
 311
 312   // TODO should be removed, when unit test has mock Graphics object available
 313   public int getBoxHeight()
 314   {
 315     return boxHeight;
 316   }
 317
 318   public void setWidth(int w)
 319   {
 320     width = w;
 321   }
 322
 323   public void setHeight(int h)
 324   {
 325     sequencesHeight = h - graphHeight;
 326   }
 327
 328   public int getWidth()
 329   {
 330     return width;
 331   }
 332
 333   public int getHeight()
 334   {
 335     return sequencesHeight + graphHeight;
 336   }
 337
 338   public int getSequencesHeight()
 339   {
 340     return sequencesHeight;
 341   }
 342
 343   public int getGraphHeight()
 344   {
 345     return graphHeight;
 346   }
 347 }