2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.viewmodel;
23 import jalview.datamodel.ColumnSelection;
24 import jalview.datamodel.HiddenSequences;
26 import java.awt.Graphics;
28 public class OverviewDimensions
30 // Default width and height values
31 private static final int DEFAULT_GRAPH_HEIGHT = 20;
33 private static final int MAX_WIDTH = 400;
35 private static final int MIN_WIDTH = 120;
37 private static final int MIN_SEQ_HEIGHT = 40;
39 private static final int MAX_SEQ_HEIGHT = 300;
41 // width of the overview panel
44 // height of sequences part of the overview panel
45 private int sequencesHeight;
47 // height of the graphs part of the overview panel
48 private int graphHeight = DEFAULT_GRAPH_HEIGHT;
50 // dimensions of box outlining current extent of view in alignment panel
51 // location of left side of box
52 private int boxX = -1;
54 // location of bottom of box
55 private int boxY = -1;
58 private int boxWidth = -1;
61 private int boxHeight = -1;
63 // scroll position in viewport corresponding to boxX
64 private int scrollCol = -1;
66 // scroll position in viewport corresponding to boxY
67 private int scrollRow = -1;
70 * Create an OverviewDimensions object
73 * positional properties of the viewport
74 * @param showAnnotationPanel
75 * true if the annotation panel is to be shown, false otherwise
77 public OverviewDimensions(ViewportRanges ranges,
78 boolean showAnnotationPanel)
80 // scale the initial size of overviewpanel to shape of alignment
81 float initialScale = (float) ranges.getAbsoluteAlignmentWidth()
82 / (float) ranges.getAbsoluteAlignmentHeight();
84 if (!showAnnotationPanel)
89 if (ranges.getAbsoluteAlignmentWidth() > ranges
90 .getAbsoluteAlignmentHeight())
94 sequencesHeight = Math.round(MAX_WIDTH / initialScale);
95 if (sequencesHeight < MIN_SEQ_HEIGHT)
97 sequencesHeight = MIN_SEQ_HEIGHT;
103 width = Math.round(MAX_WIDTH * initialScale);
104 sequencesHeight = MAX_SEQ_HEIGHT;
106 if (width < MIN_WIDTH)
114 * Check box dimensions and scroll positions and correct if necessary
117 * x position in overview panel
119 * y position in overview panel
125 * viewport position properties
127 public void updateViewportFromMouse(int mousex, int mousey,
128 HiddenSequences hiddenSeqs, ColumnSelection hiddenCols,
129 ViewportRanges ranges)
134 int alwidth = ranges.getAbsoluteAlignmentWidth();
135 int alheight = ranges.getAbsoluteAlignmentHeight();
148 // Convert x value to residue position
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
155 // convert x to residues - this is an absolute position
156 int xAsRes = Math.round((float) x * alwidth / width);
158 // get viewport width in residues
159 int vpwidth = ranges.getViewportWidth();
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
164 // so convert back after getting visible region position
165 int visXAsRes = hiddenCols.findColumnPosition(xAsRes);
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)
171 // went past the end of the alignment, adjust backwards
173 // if last position was before the end of the alignment, need to update
174 if ((scrollCol + vpwidth - 1) < visAlignWidth)
176 visXAsRes = hiddenCols.findColumnPosition(hiddenCols
177 .subtractVisibleColumns(vpwidth - 1, alwidth - 1));
181 visXAsRes = scrollCol;
186 // Convert y value to sequence position
189 // convert y to residues
190 int yAsSeq = Math.round((float) y * alheight / sequencesHeight);
192 // get viewport height in sequences
193 int vpheight = ranges.getViewportHeight();
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
198 // so convert back after getting visible region position
199 yAsSeq = hiddenSeqs.adjustForHiddenSeqs(hiddenSeqs
200 .findIndexWithoutHiddenSeqs(yAsSeq));
202 // check in case we went off the edge of the alignment
203 int visAlignHeight = hiddenSeqs.findIndexWithoutHiddenSeqs(alheight);
204 int visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(yAsSeq);
205 if (visYAsRes + vpheight - 1 > visAlignHeight)
207 // went past the end of the alignment, adjust backwards
208 if ((scrollRow + vpheight - 1) < visAlignHeight)
210 visYAsRes = hiddenSeqs.findIndexWithoutHiddenSeqs(hiddenSeqs
211 .subtractVisibleRows(vpheight - 1, alheight - 1));
215 visYAsRes = scrollRow;
219 // update scroll values
220 // scrollCol = visXAsRes;
221 // scrollRow = visYAsRes;
222 ranges.setStartRes(visXAsRes);
224 ranges.setStartSeq(visYAsRes);
228 * Update the overview panel box when the associated alignment panel is
236 * viewport position properties
238 public void setBoxPosition(HiddenSequences hiddenSeqs,
239 ColumnSelection hiddenCols, ViewportRanges ranges)
241 int alwidth = ranges.getAbsoluteAlignmentWidth();
242 int alheight = ranges.getAbsoluteAlignmentHeight();
244 // work with absolute values of startRes and endRes
245 int startRes = hiddenCols.adjustForHiddenColumns(ranges.getStartRes());
246 int endRes = hiddenCols.adjustForHiddenColumns(ranges.getEndRes());
248 // work with absolute values of startSeq and endSeq
249 int startSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getStartSeq());
250 int endSeq = hiddenSeqs.adjustForHiddenSeqs(ranges.getEndSeq());
252 // boxX, boxY is the x,y location equivalent to startRes, startSeq
253 boxX = Math.round((float) startRes * width / alwidth);
254 boxY = Math.round((float) startSeq * sequencesHeight / alheight);
256 // boxWidth is the width in residues translated to pixels
257 // since the box includes both the start and end residues, add 1 to the
260 .round((float) (endRes - startRes + 1) * width / alwidth);
261 // boxHeight is the height in sequences translated to pixels
262 boxHeight = Math.round((float) (endSeq - startSeq + 1)
268 * Draw the overview panel's viewport box on a graphics object
271 * the graphics object to draw on
273 public void drawBox(Graphics g)
275 g.drawRect(boxX, boxY, boxWidth, boxHeight);
276 g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);
279 /*public int getScrollCol()
284 public int getScrollRow()
289 // TODO should be removed, when unit test has mock Graphics object available
290 // to check boxX/boxY
296 // TODO should be removed, when unit test has mock Graphics object available
297 // to check boxX/boxY
303 // TODO should be removed, when unit test has mock Graphics object available
304 public int getBoxWidth()
309 // TODO should be removed, when unit test has mock Graphics object available
310 public int getBoxHeight()
315 public void setWidth(int w)
320 public void setHeight(int h)
322 sequencesHeight = h - graphHeight;
325 public int getWidth()
330 public int getHeight()
332 return sequencesHeight + graphHeight;
335 public int getSequencesHeight()
337 return sequencesHeight;
340 public int getGraphHeight()