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.renderer;
23 import jalview.api.AlignmentColsCollectionI;
24 import jalview.api.AlignmentRowsCollectionI;
25 import jalview.api.RendererListenerI;
26 import jalview.datamodel.AlignmentAnnotation;
27 import jalview.datamodel.AlignmentI;
28 import jalview.datamodel.Annotation;
29 import jalview.datamodel.SequenceGroup;
30 import jalview.datamodel.SequenceI;
31 import jalview.renderer.seqfeatures.FeatureColourFinder;
32 import jalview.renderer.seqfeatures.FeatureRenderer;
33 import jalview.viewmodel.OverviewDimensions;
35 import java.awt.AlphaComposite;
36 import java.awt.Color;
37 import java.awt.Graphics;
38 import java.awt.Graphics2D;
39 import java.awt.image.BufferedImage;
40 import java.beans.PropertyChangeSupport;
42 public class OverviewRenderer
44 // transparency of hidden cols/seqs overlay
45 private final float TRANSPARENCY = 0.5f;
47 private final Color HIDDEN_COLOUR = Color.DARK_GRAY.darker();
49 public static final String UPDATE = "OverviewUpdate";
51 private static final int MAX_PROGRESS = 100;
53 private PropertyChangeSupport changeSupport = new PropertyChangeSupport(
56 private FeatureColourFinder finder;
59 private BufferedImage miniMe;
61 // raw number of pixels to allocate to each column
62 private float pixelsPerCol;
64 // raw number of pixels to allocate to each row
65 private float pixelsPerSeq;
67 // height in pixels of graph
68 private int graphHeight;
70 // flag to indicate whether to halt drawing
71 private volatile boolean redraw = false;
73 // reference to alignment, needed to get sequence groups
74 private AlignmentI al;
76 private ResidueShaderI shader;
78 private OverviewResColourFinder resColFinder;
80 public OverviewRenderer(FeatureRenderer fr, OverviewDimensions od,
82 ResidueShaderI resshader, OverviewResColourFinder colFinder)
84 finder = new FeatureColourFinder(fr);
85 resColFinder = colFinder;
90 pixelsPerCol = od.getPixelsPerCol();
91 pixelsPerSeq = od.getPixelsPerSeq();
92 graphHeight = od.getGraphHeight();
93 miniMe = new BufferedImage(od.getWidth(), od.getHeight(),
94 BufferedImage.TYPE_INT_RGB);
98 * Draw alignment rows and columns onto an image
101 * Iterator over rows to be drawn
103 * Iterator over columns to be drawn
104 * @return image containing the drawing
106 public BufferedImage draw(AlignmentRowsCollectionI rows,
107 AlignmentColsCollectionI cols)
109 int rgbcolor = Color.white.getRGB();
112 int alignmentHeight = miniMe.getHeight() - graphHeight;
113 int totalPixels = miniMe.getWidth() * alignmentHeight;
115 int lastRowUpdate = 0;
116 changeSupport.firePropertyChange(UPDATE, -1, 0);
118 for (int alignmentRow : rows)
125 // get details of this alignment row
126 SequenceI seq = rows.getSequence(alignmentRow);
128 // rate limiting step when rendering overview for lots of groups
129 SequenceGroup[] allGroups = al.findAllGroups(seq);
131 // calculate where this row extends to in pixels
132 int endRow = Math.min(Math.round((seqIndex + 1) * pixelsPerSeq) - 1,
133 miniMe.getHeight() - 1);
137 for (int alignmentCol : cols)
144 // calculate where this column extends to in pixels
145 int endCol = Math.min(Math.round((colIndex + 1) * pixelsPerCol) - 1,
146 miniMe.getWidth() - 1);
148 // don't do expensive colour determination if we're not going to use it
149 // NB this is important to avoid performance issues in the overview
151 if (pixelCol <= endCol)
153 rgbcolor = getColumnColourFromSequence(allGroups, seq,
154 alignmentCol, finder);
156 // fill in the appropriate number of pixels
157 for (int row = pixelRow; row <= endRow; ++row)
159 for (int col = pixelCol; col <= endCol; ++col)
161 miniMe.setRGB(col, row, rgbcolor);
165 sendProgressUpdate((pixelCol + 1) * (endRow - pixelRow),
166 totalPixels, lastRowUpdate);
168 pixelCol = endCol + 1;
173 if (pixelRow != endRow + 1)
175 lastRowUpdate = sendProgressUpdate(endRow + 1, alignmentHeight, 0);
176 pixelRow = endRow + 1;
181 overlayHiddenRegions(rows, cols);
182 // final update to progress bar if present
185 sendProgressUpdate(pixelRow - 1, alignmentHeight, 0);
189 sendProgressUpdate(alignmentHeight, miniMe.getHeight(), 0);
195 * Calculate progress update value and fire event
197 private int sendProgressUpdate(int position, int maximum, int offset)
199 int newUpdate = offset
200 + Math.round(MAX_PROGRESS * ((float) position / maximum));
201 if (newUpdate > offset)
203 changeSupport.firePropertyChange(UPDATE, offset, newUpdate);
210 * Find the colour of a sequence at a specified column position
213 * sequence to get colour for
215 * column position to get colour for
217 * FeatureColourFinder to use
218 * @return colour of sequence at this position, as RGB
220 private int getColumnColourFromSequence(SequenceGroup[] allGroups,
221 jalview.datamodel.SequenceI seq,
222 int lastcol, FeatureColourFinder fcfinder)
224 Color color = Color.white;
226 if ((seq != null) && (seq.getLength() > lastcol))
228 color = resColFinder.getResidueColour(true, shader, allGroups, seq,
233 return color.getRGB();
237 * Overlay the hidden regions on the overview image
240 * collection of rows the overview is built over
242 * collection of columns the overview is built over
244 private void overlayHiddenRegions(AlignmentRowsCollectionI rows,
245 AlignmentColsCollectionI cols)
247 if (cols.hasHidden() || rows.hasHidden())
249 BufferedImage mask = buildHiddenImage(rows, cols, miniMe.getWidth(),
252 Graphics2D g = (Graphics2D) miniMe.getGraphics();
253 g.setComposite(AlphaComposite.getInstance(AlphaComposite.SRC_OVER,
255 g.drawImage(mask, 0, 0, miniMe.getWidth(), miniMe.getHeight(), null);
260 * Build a masking image of hidden columns and rows to be applied on top of
261 * the main overview image.
264 * collection of rows the overview is built over
266 * collection of columns the overview is built over
268 * width of overview in pixels
270 * height of overview in pixels
271 * @return BufferedImage containing mask of hidden regions
273 private BufferedImage buildHiddenImage(AlignmentRowsCollectionI rows,
274 AlignmentColsCollectionI cols, int width, int height)
277 BufferedImage hiddenImage = new BufferedImage(width, height,
278 BufferedImage.TYPE_INT_ARGB);
283 Color hidden = resColFinder.getHiddenColour();
285 Graphics2D g2d = (Graphics2D) hiddenImage.getGraphics();
287 // set background to transparent
288 g2d.setComposite(AlphaComposite.Clear);
289 g2d.fillRect(0, 0, width, height);
291 // set next colour to opaque
292 g2d.setComposite(AlphaComposite.Src);
294 for (int alignmentCol : cols)
301 // calculate where this column extends to in pixels
302 int endCol = Math.min(Math.round((colIndex + 1) * pixelsPerCol) - 1,
303 hiddenImage.getWidth() - 1);
305 if (pixelCol <= endCol)
307 // determine the colour based on the sequence and column position
308 if (cols.isHidden(alignmentCol))
310 g2d.setColor(hidden);
311 g2d.fillRect(pixelCol, 0, endCol - pixelCol + 1, height);
314 pixelCol = endCol + 1;
322 for (int alignmentRow : rows)
329 // calculate where this row extends to in pixels
330 int endRow = Math.min(Math.round((seqIndex + 1) * pixelsPerSeq) - 1,
331 miniMe.getHeight() - 1);
333 // get details of this alignment row
334 if (rows.isHidden(alignmentRow))
336 g2d.setColor(hidden);
337 g2d.fillRect(0, pixelRow, width, endRow - pixelRow + 1);
339 pixelRow = endRow + 1;
347 * Draw the alignment annotation in the overview panel
350 * the graphics object to draw on
352 * alignment annotation information
354 * alignment character width value
356 * y-position for the annotation graph
358 * the collection of columns used in the overview panel
360 public void drawGraph(Graphics g, AlignmentAnnotation anno, int charWidth,
361 int y, AlignmentColsCollectionI cols)
363 Annotation[] annotations = anno.annotations;
364 g.setColor(Color.white);
365 g.fillRect(0, 0, miniMe.getWidth(), y);
370 for (int alignmentCol : cols)
374 changeSupport.firePropertyChange(UPDATE, MAX_PROGRESS - 1, 0);
378 if (alignmentCol >= annotations.length)
380 break; // no more annotations to draw here
384 int endCol = Math.min(Math.round((colIndex + 1) * pixelsPerCol) - 1,
385 miniMe.getWidth() - 1);
387 if (annotations[alignmentCol] != null)
389 if (annotations[alignmentCol].colour == null)
391 g.setColor(Color.black);
395 g.setColor(annotations[alignmentCol].colour);
398 height = (int) ((annotations[alignmentCol].value / anno.graphMax)
405 g.fillRect(pixelCol, y - height, endCol - pixelCol + 1, height);
408 pixelCol = endCol + 1;
412 changeSupport.firePropertyChange(UPDATE, MAX_PROGRESS - 1,
417 * Allows redraw flag to be set
420 * value to set redraw to: true = redraw is occurring, false = no
423 public void setRedraw(boolean b)
431 public void addPropertyChangeListener(RendererListenerI listener)
433 changeSupport.addPropertyChangeListener(listener);
436 public void removePropertyChangeListener(RendererListenerI listener)
438 changeSupport.removePropertyChangeListener(listener);