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     else if (x >= alwidth)
 142     {
 143       x = alwidth - 1;
 144     }
 145
 146     if (y < 0)
 147     {
 148       y = 0;
 149     }
 150     else if (y >= alheight)
 151     {
 152       y = alheight - 1;
 153     }
 154
 155     //
 156     // Convert x value to residue position
 157     //
 158
 159     // need to determine where scrollCol should be, given x
 160     // to do this also need to know width of viewport, and some hidden column
 161     // correction
 162
 163     // convert x to residues - this is an absolute position
 164     int xAsRes = Math.round((float) x * alwidth / width);
 165
 166     // get viewport width in residues
 167     int vpwidth = props.getEndRes() - props.getStartRes() + 1;
 168
 169     // get where x should be when accounting for hidden cols
 170     // if x is in a hidden col region, shift to left - but we still need
 171     // absolute position
 172     // so convert back after getting visible region position
 173     xAsRes = hiddenCols.adjustForHiddenColumns(hiddenCols
 174             .findColumnPosition(xAsRes));
 175
 176     // get where end res should be by adding the viewport width on
 177     int endRes = xAsRes + vpwidth;
 178
 179     // check in case we went off the edge of the alignment
 180     if (endRes > alwidth)
 181     {
 182       // went past the end of the alignment, adjust backwards
 183       endRes = alwidth;
 184       // recalc xAsRes backwards from endRes
 185       xAsRes = endRes - vpwidth;
 186     }
 187
 188     //
 189     // Convert y value to sequence position
 190     //
 191
 192     // convert y to residues
 193     int yAsSeq = Math.round((float) y * alheight / sequencesHeight);
 194
 195     // get viewport height in sequences
 196     int vpheight = props.getEndSeq() - props.getStartSeq();
 197
 198     // get where y should be when accounting for hidden rows
 199     // if y is in a hidden row region, shift up - but we still need absolute
 200     // position,
 201     // so convert back after getting visible region position
 202     yAsSeq = hiddenSeqs.adjustForHiddenSeqs(hiddenSeqs
 203             .findIndexWithoutHiddenSeqs(yAsSeq));
 204
 205     // get where end seq should be by adding the viewport height on
 206     int endSeq = yAsSeq + vpheight;
 207
 208     // check in case we went off the edge of the alignment
 209     if (endSeq > alheight)
 210     {
 211       // went past the end of the alignment, adjust backwards
 212       endSeq = alheight;
 213       // recalc yAsSeq backwards from endSeq
 214       yAsSeq = endSeq - vpheight;
 215     }
 216
 217     // convert absolute positions back to visible alignment positions for
 218     // viewport scrolling
 219     scrollCol = hiddenCols.findColumnPosition(xAsRes);
 220     scrollRow = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
 221   }
 222
 223   /**
 224    * Update the overview panel box when the associated alignment panel is
 225    * changed
 226    *
 227    * @param hiddenSeqs
 228    *          hidden sequences
 229    * @param hiddenCols
 230    *          hidden columns
 231    * @param props
 232    *          viewport position properties
 233    */
 234   public void setBoxPosition(HiddenSequences hiddenSeqs,
 235           ColumnSelection hiddenCols, ViewportPositionProps props)
 236   {
 237     int alwidth = props.getAbsoluteAlignmentWidth();
 238     int alheight = props.getAbsoluteAlignmentHeight();
 239
 240     // work with absolute values of startRes and endRes
 241     int startRes = hiddenCols.adjustForHiddenColumns(props.getStartRes());
 242     int endRes = hiddenCols.adjustForHiddenColumns(props.getEndRes());
 243
 244     // work with absolute values of startSeq and endSeq
 245     int startSeq = hiddenSeqs.adjustForHiddenSeqs(props.getStartSeq());
 246     int endSeq = hiddenSeqs.adjustForHiddenSeqs(props.getEndSeq());
 247
 248     // boxX, boxY is the x,y location equivalent to startRes, startSeq
 249     boxX = Math.round((float) startRes * width / alwidth);
 250     boxY = Math.round((float) startSeq * sequencesHeight / alheight);
 251
 252     // boxWidth is the width in residues translated to pixels
 253     boxWidth = Math
 254             .round((float) (endRes - startRes + 1) * width / alwidth);
 255     // boxHeight is the height in sequences translated to pixels
 256     boxHeight = Math.round((float) (endSeq - startSeq) * sequencesHeight
 257             / alheight);
 258   }
 259
 260   /**
 261    * Draw the overview panel's viewport box on a graphics object
 262    *
 263    * @param g
 264    *          the graphics object to draw on
 265    */
 266   public void drawBox(Graphics g)
 267   {
 268     g.drawRect(boxX, boxY, boxWidth, boxHeight);
 269     g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);
 270   }
 271
 272   // don't like this, scroll vals are separate from setting code
 273   public int getScrollCol()
 274   {
 275     return scrollCol;
 276   }
 277
 278   public int getScrollRow()
 279   {
 280     return scrollRow;
 281   }
 282
 283   // TODO should be removed, when unit test has mock Graphics object available
 284   // to check boxX/boxY
 285   public int getBoxX()
 286   {
 287     return boxX;
 288   }
 289
 290   // TODO should be removed, when unit test has mock Graphics object available
 291   // to check boxX/boxY
 292   public int getBoxY()
 293   {
 294     return boxY;
 295   }
 296
 297   // TODO should be removed, when unit test has mock Graphics object available
 298   public int getBoxWidth()
 299   {
 300     return boxWidth;
 301   }
 302
 303   // TODO should be removed, when unit test has mock Graphics object available
 304   public int getBoxHeight()
 305   {
 306     return boxHeight;
 307   }
 308
 309   public void setWidth(int w)
 310   {
 311     width = w;
 312   }
 313
 314   public void setHeight(int h)
 315   {
 316     sequencesHeight = h - graphHeight;
 317   }
 318
 319   public int getWidth()
 320   {
 321     return width;
 322   }
 323
 324   public int getHeight()
 325   {
 326     return sequencesHeight + graphHeight;
 327   }
 328
 329   public int getSequencesHeight()
 330   {
 331     return sequencesHeight;
 332   }
 333
 334   public int getGraphHeight()
 335   {
 336     return graphHeight;
 337   }
 338 }