Merge branch 'JAL-3878_ws-overhaul-3' into with_ws_overhaul-3
[jalview.git] / src / jalview / gui / OverviewCanvas.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.gui;
22
23 import jalview.api.AlignViewportI;
24 import jalview.bin.Cache;
25 import jalview.renderer.OverviewRenderer;
26 import jalview.renderer.OverviewResColourFinder;
27 import jalview.viewmodel.OverviewDimensions;
28 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
29
30 import java.awt.Color;
31 import java.awt.Dimension;
32 import java.awt.Graphics;
33 import java.awt.image.BufferedImage;
34
35 import javax.swing.JPanel;
36
37 public class OverviewCanvas extends JPanel
38 {
39   private static final Color TRANS_GREY = new Color(100, 100, 100, 25);
40
41   // This is set true if the alignment view changes whilst
42   // the overview is being calculated
43   private volatile boolean restart = false;
44
45   private volatile boolean updaterunning = false;
46
47   private boolean dispose = false;
48
49   private BufferedImage miniMe;
50
51   private BufferedImage lastMiniMe = null;
52
53   // Can set different properties in this seqCanvas than
54   // main visible SeqCanvas
55   private SequenceRenderer sr;
56
57   private jalview.renderer.seqfeatures.FeatureRenderer fr;
58
59   private OverviewDimensions od;
60
61   private OverviewRenderer or = null;
62
63   private AlignViewportI av;
64
65   private OverviewResColourFinder cf;
66
67   private ProgressPanel progressPanel;
68
69   public OverviewCanvas(OverviewDimensions overviewDims,
70           AlignViewportI alignvp, ProgressPanel pp)
71   {
72     od = overviewDims;
73     av = alignvp;
74     progressPanel = pp;
75
76     sr = new SequenceRenderer(av);
77     sr.renderGaps = false;
78     fr = new jalview.renderer.seqfeatures.FeatureRenderer(av);
79
80     boolean useLegacy = Cache.getDefault(Preferences.USE_LEGACY_GAP, false);
81     Color gapCol = Cache.getDefaultColour(Preferences.GAP_COLOUR,
82             jalview.renderer.OverviewResColourFinder.OVERVIEW_DEFAULT_GAP);
83     Color hiddenCol = Cache.getDefaultColour(Preferences.HIDDEN_COLOUR,
84             jalview.renderer.OverviewResColourFinder.OVERVIEW_DEFAULT_HIDDEN);
85     cf = new OverviewResColourFinder(useLegacy, gapCol, hiddenCol);
86
87     setSize(od.getWidth(), od.getHeight());
88   }
89
90   /**
91    * Update the overview dimensions object used by the canvas (e.g. if we change
92    * from showing hidden columns to hiding them or vice versa)
93    * 
94    * @param overviewDims
95    */
96   public void resetOviewDims(OverviewDimensions overviewDims)
97   {
98     od = overviewDims;
99   }
100
101   /**
102    * Signals to drawing code that the associated alignment viewport has changed
103    * and a redraw will be required
104    */
105   public boolean restartDraw()
106   {
107     synchronized (this)
108     {
109       if (updaterunning)
110       {
111         restart = true;
112         if (or != null)
113         {
114           or.setRedraw(true);
115         }
116       }
117       else
118       {
119         updaterunning = true;
120       }
121       return restart;
122     }
123   }
124
125   /**
126    * Draw the overview sequences
127    * 
128    * @param showSequenceFeatures
129    *          true if sequence features are to be shown
130    * @param showAnnotation
131    *          true if the annotation is to be shown
132    * @param transferRenderer
133    *          the renderer to transfer feature colouring from
134    */
135   public void draw(boolean showSequenceFeatures, boolean showAnnotation,
136           FeatureRendererModel transferRenderer)
137   {
138     miniMe = null;
139
140     if (showSequenceFeatures)
141     {
142       fr.transferSettings(transferRenderer);
143     }
144
145     setPreferredSize(new Dimension(od.getWidth(), od.getHeight()));
146
147     or = new OverviewRenderer(fr, od, av.getAlignment(),
148             av.getResidueShading(), cf);
149
150     or.addPropertyChangeListener(progressPanel);
151
152     miniMe = or.draw(od.getRows(av.getAlignment()),
153             od.getColumns(av.getAlignment()));
154
155     Graphics mg = miniMe.getGraphics();
156
157     if (showAnnotation)
158     {
159       mg.translate(0, od.getSequencesHeight());
160       or.drawGraph(mg, av.getAlignmentConservationAnnotation(),
161               od.getGraphHeight(), od.getColumns(av.getAlignment()));
162       mg.translate(0, -od.getSequencesHeight());
163     }
164
165     or.removePropertyChangeListener(progressPanel);
166     or = null;
167     if (restart)
168     {
169       restart = false;
170       if (!dispose)
171       {
172         draw(showSequenceFeatures, showAnnotation, transferRenderer);
173       }
174     }
175     else
176     {
177       updaterunning = false;
178       lastMiniMe = miniMe;
179     }
180   }
181
182   @Override
183   public void paintComponent(Graphics g)
184   {
185     // super.paintComponent(g);
186
187     if (restart)
188     {
189       if (lastMiniMe == null)
190       {
191         g.setColor(Color.white);
192         g.fillRect(0, 0, getWidth(), getHeight());
193       }
194       else
195       {
196         g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
197       }
198       g.setColor(TRANS_GREY);
199       g.fillRect(0, 0, getWidth(), getHeight());
200     }
201     else if (lastMiniMe != null)
202     {
203       // is this a resize?
204       if ((getWidth() > 0) && (getHeight() > 0)
205               && ((getWidth() != od.getWidth())
206                       || (getHeight() != od.getHeight())))
207       {
208         // if there is annotation, scale the alignment and annotation
209         // separately
210         if (od.getGraphHeight() > 0 && od.getSequencesHeight() > 0 // BH 2019
211         )
212         {
213           BufferedImage topImage = lastMiniMe.getSubimage(0, 0,
214                   od.getWidth(), od.getSequencesHeight());
215           BufferedImage bottomImage = lastMiniMe.getSubimage(0,
216                   od.getSequencesHeight(), od.getWidth(),
217                   od.getGraphHeight());
218
219           // must be done at this point as we rely on using old width/height
220           // above, and new width/height below
221           od.setWidth(getWidth());
222           od.setHeight(getHeight());
223
224           // stick the images back together so lastMiniMe is consistent in the
225           // event of a repaint - BUT probably not thread safe
226           lastMiniMe = new BufferedImage(od.getWidth(), od.getHeight(),
227                   BufferedImage.TYPE_INT_RGB);
228           Graphics lg = lastMiniMe.getGraphics();
229           lg.drawImage(topImage, 0, 0, od.getWidth(),
230                   od.getSequencesHeight(), null);
231           lg.drawImage(bottomImage, 0, od.getSequencesHeight(),
232                   od.getWidth(), od.getGraphHeight(), this);
233           lg.dispose();
234         }
235         else
236         {
237           od.setWidth(getWidth());
238           od.setHeight(getHeight());
239         }
240
241         // make sure the box is in the right place
242         od.setBoxPosition(av.getAlignment().getHiddenSequences(),
243                 av.getAlignment().getHiddenColumns());
244       }
245       // fall back to normal behaviour
246       g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
247     }
248     else
249     {
250       g.drawImage(lastMiniMe, 0, 0, getWidth(), getHeight(), this);
251     }
252
253     // draw the box
254     g.setColor(Color.red);
255     od.drawBox(g);
256   }
257
258   public void dispose()
259   {
260     dispose = true;
261     od = null;
262     synchronized (this)
263     {
264       restart = true;
265       if (or != null)
266       {
267         or.setRedraw(true);
268       }
269     }
270   }
271 }