JAL-2443 push getResidueBoxColour inside getResidueColour
[jalview.git] / src / jalview / appletgui / OverviewPanel.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.appletgui;
22
23 import jalview.datamodel.AlignmentI;
24 import jalview.renderer.seqfeatures.FeatureColourFinder;
25
26 import java.awt.Color;
27 import java.awt.Dimension;
28 import java.awt.Frame;
29 import java.awt.Graphics;
30 import java.awt.Image;
31 import java.awt.Panel;
32 import java.awt.event.ComponentAdapter;
33 import java.awt.event.ComponentEvent;
34 import java.awt.event.MouseEvent;
35 import java.awt.event.MouseListener;
36 import java.awt.event.MouseMotionListener;
37
38 public class OverviewPanel extends Panel implements Runnable,
39         MouseMotionListener, MouseListener
40 {
41   Image miniMe;
42
43   Image offscreen;
44
45   AlignViewport av;
46
47   AlignmentPanel ap;
48
49   float scalew = 1f;
50
51   float scaleh = 1f;
52
53   public int width, sequencesHeight;
54
55   int graphHeight = 20;
56
57   int boxX = -1, boxY = -1, boxWidth = -1, boxHeight = -1;
58
59   boolean resizing = false;
60
61   // Can set different properties in this seqCanvas than
62   // main visible SeqCanvas
63   SequenceRenderer sr;
64
65   FeatureRenderer fr;
66
67   Frame nullFrame;
68
69   public OverviewPanel(AlignmentPanel ap)
70   {
71     this.av = ap.av;
72     this.ap = ap;
73     setLayout(null);
74     nullFrame = new Frame();
75     nullFrame.addNotify();
76
77     sr = new SequenceRenderer(av);
78     sr.graphics = nullFrame.getGraphics();
79     sr.renderGaps = false;
80     sr.forOverview = true;
81     fr = new FeatureRenderer(av);
82
83     // scale the initial size of overviewpanel to shape of alignment
84     float initialScale = (float) av.getAlignment().getWidth()
85             / (float) av.getAlignment().getHeight();
86
87     if (av.getSequenceConsensusHash() == null)
88     {
89       graphHeight = 0;
90     }
91
92     if (av.getAlignment().getWidth() > av.getAlignment().getHeight())
93     {
94       // wider
95       width = 400;
96       sequencesHeight = (int) (400f / initialScale);
97       if (sequencesHeight < 40)
98       {
99         sequencesHeight = 40;
100       }
101     }
102     else
103     {
104       // taller
105       width = (int) (400f * initialScale);
106       sequencesHeight = 300;
107       if (width < 120)
108       {
109         width = 120;
110       }
111     }
112
113     setSize(new Dimension(width, sequencesHeight + graphHeight));
114     addComponentListener(new ComponentAdapter()
115     {
116
117       @Override
118       public void componentResized(ComponentEvent evt)
119       {
120         if (getSize().width != width
121                 || getSize().height != sequencesHeight + graphHeight)
122         {
123           updateOverviewImage();
124         }
125       }
126     });
127
128     addMouseMotionListener(this);
129
130     addMouseListener(this);
131
132     updateOverviewImage();
133
134   }
135
136   @Override
137   public void mouseEntered(MouseEvent evt)
138   {
139   }
140
141   @Override
142   public void mouseExited(MouseEvent evt)
143   {
144   }
145
146   @Override
147   public void mouseClicked(MouseEvent evt)
148   {
149   }
150
151   @Override
152   public void mouseMoved(MouseEvent evt)
153   {
154   }
155
156   @Override
157   public void mousePressed(MouseEvent evt)
158   {
159     boxX = evt.getX();
160     boxY = evt.getY();
161     checkValid();
162   }
163
164   @Override
165   public void mouseReleased(MouseEvent evt)
166   {
167     boxX = evt.getX();
168     boxY = evt.getY();
169     checkValid();
170   }
171
172   @Override
173   public void mouseDragged(MouseEvent evt)
174   {
175     boxX = evt.getX();
176     boxY = evt.getY();
177     checkValid();
178   }
179
180   void checkValid()
181   {
182     if (boxY < 0)
183     {
184       boxY = 0;
185     }
186
187     if (boxY > (sequencesHeight - boxHeight))
188     {
189       boxY = sequencesHeight - boxHeight + 1;
190     }
191
192     if (boxX < 0)
193     {
194       boxX = 0;
195     }
196
197     if (boxX > (width - boxWidth))
198     {
199       if (av.hasHiddenColumns())
200       {
201         // Try smallest possible box
202         boxWidth = (int) ((av.endRes - av.startRes + 1) * av.getCharWidth() * scalew);
203       }
204       boxX = width - boxWidth;
205     }
206
207     int col = (int) (boxX / scalew / av.getCharWidth());
208     int row = (int) (boxY / scaleh / av.getCharHeight());
209
210     if (av.hasHiddenColumns())
211     {
212       if (!av.getColumnSelection().isVisible(col))
213       {
214         return;
215       }
216
217       col = av.getColumnSelection().findColumnPosition(col);
218     }
219
220     if (av.hasHiddenRows())
221     {
222       row = av.getAlignment().getHiddenSequences()
223               .findIndexWithoutHiddenSeqs(row);
224     }
225
226     ap.setScrollValues(col, row);
227     ap.paintAlignment(false);
228   }
229
230   /**
231    * DOCUMENT ME!
232    */
233   public void updateOverviewImage()
234   {
235     if (resizing)
236     {
237       resizeAgain = true;
238       return;
239     }
240
241     if (av.isShowSequenceFeatures())
242     {
243       fr.transferSettings(ap.seqPanel.seqCanvas.fr);
244     }
245
246     resizing = true;
247
248     if ((getSize().width > 0) && (getSize().height > 0))
249     {
250       width = getSize().width;
251       sequencesHeight = getSize().height - graphHeight;
252     }
253     setSize(new Dimension(width, sequencesHeight + graphHeight));
254
255     Thread thread = new Thread(this);
256     thread.start();
257     repaint();
258   }
259
260   // This is set true if the user resizes whilst
261   // the overview is being calculated
262   boolean resizeAgain = false;
263
264   @Override
265   public void run()
266   {
267     miniMe = null;
268     int alwidth = av.getAlignment().getWidth();
269     int alheight = av.getAlignment().getHeight()
270             + av.getAlignment().getHiddenSequences().getSize();
271
272     if (av.isShowSequenceFeatures())
273     {
274       fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());
275     }
276
277     if (getSize().width > 0 && getSize().height > 0)
278     {
279       width = getSize().width;
280       sequencesHeight = getSize().height - graphHeight;
281     }
282
283     setSize(new Dimension(width, sequencesHeight + graphHeight));
284
285     int fullsizeWidth = alwidth * av.getCharWidth();
286     int fullsizeHeight = alheight * av.getCharHeight();
287
288     scalew = (float) width / (float) fullsizeWidth;
289     scaleh = (float) sequencesHeight / (float) fullsizeHeight;
290
291     miniMe = nullFrame.createImage(width, sequencesHeight + graphHeight);
292     offscreen = nullFrame.createImage(width, sequencesHeight + graphHeight);
293
294     Graphics mg = miniMe.getGraphics();
295     float sampleCol = (float) alwidth / (float) width;
296     float sampleRow = (float) alheight / (float) sequencesHeight;
297
298     int lastcol = 0, lastrow = 0;
299     int xstart = 0, ystart = 0;
300     Color color = Color.yellow;
301     int row, col, sameRow = 0, sameCol = 0;
302     jalview.datamodel.SequenceI seq;
303     final boolean hasHiddenRows = av.hasHiddenRows(), hasHiddenCols = av
304             .hasHiddenColumns();
305     boolean hiddenRow = false;
306     AlignmentI alignment = av.getAlignment();
307
308     FeatureColourFinder finder = new FeatureColourFinder(fr);
309     for (row = 0; row <= sequencesHeight; row++)
310     {
311       if (resizeAgain)
312       {
313         break;
314       }
315       if ((int) (row * sampleRow) == lastrow)
316       {
317         sameRow++;
318         continue;
319       }
320
321       hiddenRow = false;
322       if (hasHiddenRows)
323       {
324         seq = alignment.getHiddenSequences().getHiddenSequence(lastrow);
325         if (seq == null)
326         {
327           int index = alignment.getHiddenSequences()
328                   .findIndexWithoutHiddenSeqs(lastrow);
329
330           seq = alignment.getSequenceAt(index);
331         }
332         else
333         {
334           hiddenRow = true;
335         }
336       }
337       else
338       {
339         seq = alignment.getSequenceAt(lastrow);
340       }
341
342       for (col = 0; col < width; col++)
343       {
344         if ((int) (col * sampleCol) == lastcol
345                 && (int) (row * sampleRow) == lastrow)
346         {
347           sameCol++;
348           continue;
349         }
350
351         lastcol = (int) (col * sampleCol);
352
353         if (seq.getLength() > lastcol)
354         {
355           color = sr.getResidueColour(seq, lastcol, finder);
356         }
357         else
358         {
359           color = Color.white;
360         }
361
362         if (hiddenRow
363                 || (hasHiddenCols && !av.getColumnSelection().isVisible(
364                         lastcol)))
365         {
366           color = color.darker().darker();
367         }
368
369         mg.setColor(color);
370         if (sameCol == 1 && sameRow == 1)
371         {
372           mg.drawLine(xstart, ystart, xstart, ystart);
373         }
374         else
375         {
376           mg.fillRect(xstart, ystart, sameCol, sameRow);
377         }
378
379         xstart = col;
380         sameCol = 1;
381       }
382       lastrow = (int) (row * sampleRow);
383       ystart = row;
384       sameRow = 1;
385     }
386
387     if (av.getAlignmentConservationAnnotation() != null)
388     {
389       for (col = 0; col < width; col++)
390       {
391         if (resizeAgain)
392         {
393           break;
394         }
395         lastcol = (int) (col * sampleCol);
396         {
397           mg.translate(col, sequencesHeight);
398           ap.annotationPanel.renderer.drawGraph(mg,
399                   av.getAlignmentConservationAnnotation(),
400                   av.getAlignmentConservationAnnotation().annotations,
401                   (int) (sampleCol) + 1, graphHeight,
402                   (int) (col * sampleCol), (int) (col * sampleCol) + 1);
403           mg.translate(-col, -sequencesHeight);
404         }
405       }
406     }
407     System.gc();
408
409     resizing = false;
410
411     setBoxPosition();
412
413     if (resizeAgain)
414     {
415       resizeAgain = false;
416       updateOverviewImage();
417     }
418   }
419
420   public void setBoxPosition()
421   {
422     int fullsizeWidth = av.getAlignment().getWidth() * av.getCharWidth();
423     int fullsizeHeight = (av.getAlignment().getHeight() + av.getAlignment()
424             .getHiddenSequences().getSize())
425             * av.getCharHeight();
426
427     int startRes = av.getStartRes();
428     int endRes = av.getEndRes();
429
430     if (av.hasHiddenColumns())
431     {
432       startRes = av.getColumnSelection().adjustForHiddenColumns(startRes);
433       endRes = av.getColumnSelection().adjustForHiddenColumns(endRes);
434     }
435
436     int startSeq = av.startSeq;
437     int endSeq = av.endSeq;
438
439     if (av.hasHiddenRows())
440     {
441       startSeq = av.getAlignment().getHiddenSequences()
442               .adjustForHiddenSeqs(startSeq);
443
444       endSeq = av.getAlignment().getHiddenSequences()
445               .adjustForHiddenSeqs(endSeq);
446
447     }
448
449     scalew = (float) width / (float) fullsizeWidth;
450     scaleh = (float) sequencesHeight / (float) fullsizeHeight;
451
452     boxX = (int) (startRes * av.getCharWidth() * scalew);
453     boxY = (int) (startSeq * av.getCharHeight() * scaleh);
454
455     if (av.hasHiddenColumns())
456     {
457       boxWidth = (int) ((endRes - startRes + 1) * av.getCharWidth() * scalew);
458     }
459     else
460     {
461       boxWidth = (int) ((endRes - startRes + 1) * av.getCharWidth() * scalew);
462     }
463
464     boxHeight = (int) ((endSeq - startSeq) * av.getCharHeight() * scaleh);
465
466     repaint();
467   }
468
469   @Override
470   public void update(Graphics g)
471   {
472     paint(g);
473   }
474
475   @Override
476   public void paint(Graphics g)
477   {
478     Graphics og = offscreen.getGraphics();
479     if (miniMe != null)
480     {
481       og.drawImage(miniMe, 0, 0, this);
482       og.setColor(Color.red);
483       og.drawRect(boxX, boxY, boxWidth, boxHeight);
484       og.drawRect(boxX + 1, boxY + 1, boxWidth - 2, boxHeight - 2);
485       g.drawImage(offscreen, 0, 0, this);
486     }
487   }
488
489 }