Merge branch 'releases/Release_2_11_4_Branch'
[jalview.git] / 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.api.AlignmentColsCollectionI;
24 import jalview.api.AlignmentRowsCollectionI;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.HiddenColumns;
27 import jalview.datamodel.HiddenSequences;
28
29 import java.awt.Graphics;
30
31 public abstract class OverviewDimensions
32 {
33   protected static final int MAX_WIDTH = 400;
34
35   protected static final int MIN_WIDTH = 120;
36
37   protected static final int MIN_SEQ_HEIGHT = 40;
38
39   protected static final int MAX_SEQ_HEIGHT = 300;
40
41   private static final int DEFAULT_GRAPH_HEIGHT = 20;
42
43   protected int width;
44
45   protected int sequencesHeight;
46
47   protected int graphHeight = DEFAULT_GRAPH_HEIGHT;
48
49   protected int boxX = -1;
50
51   protected int boxY = -1;
52
53   protected int boxWidth = -1;
54
55   protected int boxHeight = -1;
56
57   protected int alwidth;
58
59   protected int alheight;
60
61   /**
62    * Create an OverviewDimensions object
63    * 
64    * @param ranges
65    *          positional properties of the viewport
66    * @param showAnnotationPanel
67    *          true if the annotation panel is to be shown, false otherwise
68    */
69   public OverviewDimensions(ViewportRanges ranges,
70           boolean showAnnotationPanel)
71   {
72     // scale the initial size of overviewpanel to shape of alignment
73     float initialScale = (float) ranges.getAbsoluteAlignmentWidth()
74             / (float) ranges.getAbsoluteAlignmentHeight();
75
76     if (!showAnnotationPanel)
77     {
78       graphHeight = 0;
79     }
80
81     if (ranges.getAbsoluteAlignmentWidth() > ranges
82             .getAbsoluteAlignmentHeight())
83     {
84       // wider
85       width = MAX_WIDTH;
86       sequencesHeight = Math.round(MAX_WIDTH / initialScale);
87       if (sequencesHeight < MIN_SEQ_HEIGHT)
88       {
89         sequencesHeight = MIN_SEQ_HEIGHT;
90       }
91     }
92     else
93     {
94       // taller
95       width = Math.round(MAX_WIDTH * initialScale);
96       sequencesHeight = MAX_SEQ_HEIGHT;
97
98       if (width < MIN_WIDTH)
99       {
100         width = MIN_WIDTH;
101       }
102     }
103   }
104
105   /**
106    * Draw the overview panel's viewport box on a graphics object
107    * 
108    * @param g
109    *          the graphics object to draw on
110    */
111   public void drawBox(Graphics g)
112   {
113     g.drawRect(boxX, boxY, boxWidth, boxHeight);
114     g.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);
115   }
116
117   public int getBoxX()
118   {
119     return boxX;
120   }
121
122   public int getBoxY()
123   {
124     return boxY;
125   }
126
127   public int getBoxWidth()
128   {
129     return boxWidth;
130   }
131
132   public int getBoxHeight()
133   {
134     return boxHeight;
135   }
136
137   public int getWidth()
138   {
139     return width;
140   }
141
142   public int getHeight()
143   {
144     return sequencesHeight + graphHeight;
145   }
146
147   public int getSequencesHeight()
148   {
149     return sequencesHeight;
150   }
151
152   public int getGraphHeight()
153   {
154     return graphHeight;
155   }
156
157   public float getPixelsPerCol()
158   {
159     resetAlignmentDims();
160     return (float) width / alwidth;
161   }
162
163   public float getPixelsPerSeq()
164   {
165     resetAlignmentDims();
166     return (float) sequencesHeight / alheight;
167   }
168
169   public void setWidth(int w)
170   {
171     width = w;
172   }
173
174   public void setHeight(int h)
175   {
176     sequencesHeight = h - graphHeight;
177   }
178
179   /**
180    * Update the viewport location from a mouse click in the overview panel
181    * 
182    * @param mousex
183    *          x location of mouse
184    * @param mousey
185    *          y location of mouse
186    * @param hiddenSeqs
187    *          the alignment's hidden sequences
188    * @param hiddenCols
189    *          the alignment's hidden columns
190    */
191   public abstract void updateViewportFromMouse(int mousex, int mousey,
192           HiddenSequences hiddenSeqs, HiddenColumns hiddenCols);
193
194   /**
195    * Set the overview panel's box position to match the viewport
196    * 
197    * @param hiddenSeqs
198    *          the alignment's hidden sequences
199    * @param hiddenCols
200    *          the alignment's hidden columns
201    */
202   public abstract void setBoxPosition(HiddenSequences hiddenSeqs,
203           HiddenColumns hiddenCols);
204
205   /**
206    * Get the collection of columns used by this overview dimensions object
207    * 
208    * @param hiddenCols
209    *          the alignment's hidden columns
210    * @return a column collection
211    */
212   public abstract AlignmentColsCollectionI getColumns(AlignmentI al);
213
214   /**
215    * Get the collection of rows used by this overview dimensions object
216    * 
217    * @param al
218    *          the alignment
219    * @return a row collection
220    */
221   public abstract AlignmentRowsCollectionI getRows(AlignmentI al);
222
223   /**
224    * Updates overview dimensions to account for current alignment dimensions
225    */
226   protected abstract void resetAlignmentDims();
227
228   protected void setBoxPosition(int startRes, int startSeq, int vpwidth,
229           int vpheight)
230   {
231     resetAlignmentDims();
232
233     // boxX, boxY is the x,y location equivalent to startRes, startSeq
234     int xPos = Math.min(startRes, alwidth - vpwidth + 1);
235     boxX = Math.round((float) xPos * width / alwidth);
236     boxY = Math.round((float) startSeq * sequencesHeight / alheight);
237
238     // boxWidth is the width in residues translated to pixels
239     boxWidth = Math.round((float) vpwidth * width / alwidth);
240
241     // boxHeight is the height in sequences translated to pixels
242     boxHeight = Math.round((float) vpheight * sequencesHeight / alheight);
243   }
244 }