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.api.AlignmentColsCollectionI;
24 import jalview.api.AlignmentRowsCollectionI;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.HiddenColumns;
27 import jalview.datamodel.HiddenSequences;
29 import java.awt.Graphics;
31 public abstract class OverviewDimensions
33 protected static final int MAX_WIDTH = 400;
35 protected static final int MIN_WIDTH = 120;
37 protected static final int MIN_SEQ_HEIGHT = 40;
39 protected static final int MAX_SEQ_HEIGHT = 300;
41 private static final int DEFAULT_GRAPH_HEIGHT = 20;
45 protected int sequencesHeight;
47 protected int graphHeight = DEFAULT_GRAPH_HEIGHT;
49 protected int boxX = -1;
51 protected int boxY = -1;
53 protected int boxWidth = -1;
55 protected int boxHeight = -1;
57 protected int alwidth;
59 protected int alheight;
61 protected float widthRatio;
63 protected float heightRatio;
66 * Create an OverviewDimensions object
69 * positional properties of the viewport
70 * @param showAnnotationPanel
71 * true if the annotation panel is to be shown, false otherwise
73 public OverviewDimensions(ViewportRanges ranges,
74 boolean showAnnotationPanel)
76 // scale the initial size of overviewpanel to shape of alignment
77 float initialScale = (float) ranges.getAbsoluteAlignmentWidth()
78 / (float) ranges.getAbsoluteAlignmentHeight();
80 if (!showAnnotationPanel)
85 if (ranges.getAbsoluteAlignmentWidth() > ranges
86 .getAbsoluteAlignmentHeight())
90 sequencesHeight = Math.round(MAX_WIDTH / initialScale);
91 if (sequencesHeight < MIN_SEQ_HEIGHT)
93 sequencesHeight = MIN_SEQ_HEIGHT;
99 width = Math.round(MAX_WIDTH * initialScale);
100 sequencesHeight = MAX_SEQ_HEIGHT;
102 if (width < MIN_WIDTH)
110 * Draw the overview panel's viewport box on a graphics object
113 * the graphics object to draw on
115 public void drawBox(Graphics g)
117 g.drawRect(boxX, boxY, boxWidth, boxHeight);
118 g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);
131 public int getBoxWidth()
136 public int getBoxHeight()
141 public int getWidth()
146 public int getHeight()
148 return sequencesHeight + graphHeight;
151 public int getSequencesHeight()
153 return sequencesHeight;
156 public int getGraphHeight()
161 public float getPixelsPerCol()
163 resetAlignmentDims();
164 return (float) width / alwidth;
167 public float getPixelsPerSeq()
169 resetAlignmentDims();
170 return (float) sequencesHeight / alheight;
173 public void setWidth(int w)
178 public void setHeight(int h)
180 sequencesHeight = h - graphHeight;
184 * Update the viewport location from a mouse click in the overview panel
187 * x location of mouse
189 * y location of mouse
191 * the alignment's hidden sequences
193 * the alignment's hidden columns
195 public abstract void updateViewportFromMouse(int mousex, int mousey,
196 HiddenSequences hiddenSeqs, HiddenColumns hiddenCols);
199 * Update the viewport location from a mouse drag within the overview's box
202 * x location of mouse
204 * y location of mouse
206 * the alignment's hidden sequences
208 * the alignment's hidden columns
210 public abstract void adjustViewportFromMouse(int mousex, int mousey,
211 HiddenSequences hiddenSeqs, HiddenColumns hiddenCols);
214 * Initialise dragging from the mouse - must be called on initial mouse click
215 * before using adjustViewportFromMouse in drag operations
218 * x location of mouse
220 * y location of mouse
222 * the alignment's hidden sequences
224 * the alignment's hidden columns
226 public abstract void setDragPoint(int x, int y,
227 HiddenSequences hiddenSeqs, HiddenColumns hiddenCols);
230 * Move the viewport so that the top left corner of the overview's box
231 * is at the mouse position (leftx, topy)
233 protected abstract void updateViewportFromTopLeft(int leftx, int topy,
234 HiddenSequences hiddenSeqs, HiddenColumns hiddenCols);
237 * Set the overview panel's box position to match the viewport
240 * the alignment's hidden sequences
242 * the alignment's hidden columns
244 public abstract void setBoxPosition(HiddenSequences hiddenSeqs,
245 HiddenColumns hiddenCols);
248 * Get the collection of columns used by this overview dimensions object
251 * the alignment's hidden columns
252 * @return a column collection
254 public abstract AlignmentColsCollectionI getColumns(AlignmentI al);
257 * Get the collection of rows used by this overview dimensions object
261 * @return a row collection
263 public abstract AlignmentRowsCollectionI getRows(AlignmentI al);
266 * Updates overview dimensions to account for current alignment dimensions
268 protected abstract void resetAlignmentDims();
271 * Given the box coordinates in residues and sequences, set the box dimensions in the overview window
273 protected void setBoxPosition(int startRes, int startSeq, int vpwidth,
276 resetAlignmentDims();
278 // boxX, boxY is the x,y location equivalent to startRes, startSeq
279 int xPos = Math.min(startRes, alwidth - vpwidth + 1);
280 boxX = Math.round((float) xPos * width / alwidth);
281 boxY = Math.round((float) startSeq * sequencesHeight / alheight);
283 // boxWidth is the width in residues translated to pixels
284 boxWidth = Math.round((float) vpwidth * width / alwidth);
286 // boxHeight is the height in sequences translated to pixels
287 boxHeight = Math.round((float) vpheight * sequencesHeight / alheight);
291 * Answers if a mouse position is in the overview's red box
297 * @return true if (x,y) is inside the box
299 public boolean isPositionInBox(int x, int y)
301 return (x > boxX && y > boxY && x < boxX + boxWidth
302 && y < boxY + boxHeight);
306 * Given the centre x position, calculate the box's left x position
308 protected abstract int getLeftXFromCentreX(int mousex,
309 HiddenColumns hidden);
312 * Given the centre y position, calculate the box's top y position
314 protected abstract int getTopYFromCentreY(int mousey,
315 HiddenSequences hidden);