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 java.awt.BasicStroke;
24 import java.awt.Color;
26 import java.awt.FontMetrics;
27 import java.awt.Graphics;
28 import java.awt.Graphics2D;
29 import java.awt.Image;
30 import java.awt.RenderingHints;
31 import java.awt.Stroke;
32 import java.awt.geom.AffineTransform;
33 import java.awt.image.ImageObserver;
34 import java.util.BitSet;
35 import java.util.Hashtable;
37 import org.jfree.graphics2d.svg.SVGGraphics2D;
38 import org.jibble.epsgraphics.EpsGraphics2D;
40 import jalview.analysis.AAFrequency;
41 import jalview.analysis.CodingUtils;
42 import jalview.analysis.Rna;
43 import jalview.analysis.StructureFrequency;
44 import jalview.api.AlignViewportI;
45 import jalview.bin.Cache;
46 import jalview.bin.Console;
47 import jalview.datamodel.AlignmentAnnotation;
48 import jalview.datamodel.Annotation;
49 import jalview.datamodel.ColumnSelection;
50 import jalview.datamodel.HiddenColumns;
51 import jalview.datamodel.ProfilesI;
52 import jalview.renderer.api.AnnotationRendererFactoryI;
53 import jalview.renderer.api.AnnotationRowRendererI;
54 import jalview.schemes.ColourSchemeI;
55 import jalview.schemes.NucleotideColourScheme;
56 import jalview.schemes.ResidueProperties;
57 import jalview.schemes.ZappoColourScheme;
58 import jalview.util.Platform;
60 public class AnnotationRenderer
62 private static final int UPPER_TO_LOWER = 'a' - 'A'; // 32
64 private static final int CHAR_A = 'A'; // 65
66 private static final int CHAR_Z = 'Z'; // 90
69 * flag indicating if timing and redraw parameter info should be output
71 private final boolean debugRedraw;
73 private int charWidth, endRes, charHeight;
75 private boolean validCharWidth, hasHiddenColumns;
77 private FontMetrics fm;
79 private final boolean USE_FILL_ROUND_RECT = Platform.isAMacAndNotJS();
81 boolean av_renderHistogram = true, av_renderProfile = true,
82 av_normaliseProfile = false;
84 ResidueShaderI profcolour = null;
86 private ColumnSelection columnSelection;
88 private HiddenColumns hiddenColumns;
90 private ProfilesI hconsensus;
92 private Hashtable<String, Object>[] complementConsensus;
94 private Hashtable<String, Object>[] hStrucConsensus;
96 private boolean av_ignoreGapsConsensus;
98 private boolean vectorRendition = false;
100 private boolean glyphLineDrawn = false;
103 * attributes set from AwtRenderPanelI
106 * old image used when data is currently being calculated and cannot be
109 private Image fadedImage;
112 * panel being rendered into
114 private ImageObserver annotationPanel;
117 * width of image to render in panel
119 private int imgWidth;
122 * offset to beginning of visible area
127 * offset to end of visible area
129 private int visHeight;
132 * indicate if the renderer should only render the visible portion of the
133 * annotation given the current view settings
135 private boolean useClip = true;
138 * master flag indicating if renderer should ever try to clip. not enabled for
141 private boolean canClip = false;
143 public AnnotationRenderer()
149 * Create a new annotation Renderer
152 * flag indicating if timing and redraw parameter info should be
155 public AnnotationRenderer(boolean debugRedraw)
157 this.debugRedraw = debugRedraw;
161 * Remove any references and resources when this object is no longer required
163 public void dispose()
165 hiddenColumns = null;
167 complementConsensus = null;
168 hStrucConsensus = null;
170 annotationPanel = null;
171 rendererFactoryI = null;
174 void drawStemAnnot(Graphics g, Annotation[] row_annotations, int lastSSX,
175 int x, int y, int iconOffset, int startRes, int column,
176 boolean validRes, boolean validEnd)
178 g.setColor(STEM_COLOUR);
179 int sCol = (lastSSX / charWidth)
180 + hiddenColumns.visibleToAbsoluteColumn(startRes);
182 int x2 = (x * charWidth);
184 char dc = (column == 0 || row_annotations[column - 1] == null) ? ' '
185 : row_annotations[column - 1].secondaryStructure;
187 boolean diffupstream = sCol == 0 || row_annotations[sCol - 1] == null
188 || dc != row_annotations[sCol - 1].secondaryStructure;
189 boolean diffdownstream = !validRes || !validEnd
190 || row_annotations[column] == null
191 || dc != row_annotations[column].secondaryStructure;
193 if (column > 0 && Rna.isClosingParenthesis(dc))
196 // if (validRes && column>1 && row_annotations[column-2]!=null &&
197 // dc.equals(row_annotations[column-2].displayCharacter))
200 * if new annotation with a closing base pair half of the stem,
201 * display a backward arrow
203 fillPolygon(g, new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
205 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset },
216 // display a forward arrow
220 * if annotation ending with an opeing base pair half of the stem,
221 * display a forward arrow
223 fillPolygon(g, new int[] { x2 - 5, x2 - 5, x2 },
225 { y + iconOffset, y + 14 + iconOffset, y + 8 + iconOffset },
235 fillRect(g, x1, y + 4 + iconOffset, x2 - x1, 7);
238 void drawNotCanonicalAnnot(Graphics g, Color nonCanColor,
239 Annotation[] row_annotations, int lastSSX, int x, int y,
240 int iconOffset, int startRes, int column, boolean validRes,
243 // Console.info(nonCanColor);
245 int sCol = (lastSSX / charWidth)
246 + hiddenColumns.visibleToAbsoluteColumn(startRes);
248 int x2 = (x * charWidth);
250 String dc = (column == 0 || row_annotations[column - 1] == null) ? ""
251 : row_annotations[column - 1].displayCharacter;
253 boolean diffupstream = sCol == 0 || row_annotations[sCol - 1] == null
254 || !dc.equals(row_annotations[sCol - 1].displayCharacter);
255 boolean diffdownstream = !validRes || !validEnd
256 || row_annotations[column] == null
257 || !dc.equals(row_annotations[column].displayCharacter);
258 // Console.info("Column "+column+" diff up:
260 // down:"+diffdownstream);
261 // If a closing base pair half of the stem, display a backward arrow
262 if (diffupstream || diffdownstream)
264 // draw glyphline under arrow
265 drawGlyphLine(g, lastSSX, x, y, iconOffset);
267 g.setColor(nonCanColor);
268 if (column > 0 && Rna.isClosingParenthesis(dc))
272 // if (validRes && column>1 && row_annotations[column-2]!=null &&
273 // dc.equals(row_annotations[column-2].displayCharacter))
275 fillPolygon(g, new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
277 { y + iconOffset + 1, y + 13 + iconOffset,
278 y + 7 + iconOffset },
290 // display a forward arrow
293 fillPolygon(g, new int[] { x2 - 6, x2 - 6, x2 - 1 },
295 { y + iconOffset + 1, y + 13 + iconOffset,
296 y + 7 + iconOffset },
307 fillRect(g, x1, y + 4 + iconOffset, x2 - x1, 6);
310 // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI
312 public void updateFromAwtRenderPanel(AwtRenderPanelI annotPanel,
315 fm = annotPanel.getFontMetrics();
316 annotationPanel = annotPanel;
317 fadedImage = annotPanel.getFadedImage();
318 imgWidth = annotPanel.getFadedImageWidth();
319 // visible area for rendering
320 int[] bounds = annotPanel.getVisibleVRange();
324 visHeight = bounds[1];
339 rendererFactoryI = AnnotationRendererFactory.getRendererFactory();
340 updateFromAlignViewport(av);
343 public void updateFromAlignViewport(AlignViewportI av)
345 charWidth = av.getCharWidth();
346 endRes = av.getRanges().getEndRes();
347 charHeight = av.getCharHeight();
348 hasHiddenColumns = av.hasHiddenColumns();
349 validCharWidth = av.isValidCharWidth();
350 av_renderHistogram = av.isShowConsensusHistogram();
351 av_renderProfile = av.isShowSequenceLogo();
352 av_normaliseProfile = av.isNormaliseSequenceLogo();
353 profcolour = av.getResidueShading();
354 if (profcolour == null || profcolour.getColourScheme() == null)
357 * Use default colour for sequence logo if
358 * the alignment has no colourscheme set
359 * (would like to use user preference but n/a for applet)
361 ColourSchemeI col = av.getAlignment().isNucleotide()
362 ? new NucleotideColourScheme()
363 : new ZappoColourScheme();
364 profcolour = new ResidueShader(col);
366 columnSelection = av.getColumnSelection();
367 hiddenColumns = av.getAlignment().getHiddenColumns();
368 hconsensus = av.getSequenceConsensusHash();
369 complementConsensus = av.getComplementConsensusHash();
370 hStrucConsensus = av.getRnaStructureConsensusHash();
371 av_ignoreGapsConsensus = av.isIgnoreGapsConsensus();
375 * Returns profile data; the first element is the profile type, the second is
376 * the number of distinct values, the third the total count, and the remainder
377 * depend on the profile type.
383 int[] getProfileFor(AlignmentAnnotation aa, int column)
385 // TODO : consider refactoring the global alignment calculation
386 // properties/rendering attributes as a global 'alignment group' which holds
387 // all vis settings for the alignment as a whole rather than a subset
389 if (aa.autoCalculated && (aa.label.startsWith("Consensus")
390 || aa.label.startsWith("cDNA Consensus")))
392 boolean forComplement = aa.label.startsWith("cDNA Consensus");
393 if (aa.groupRef != null && aa.groupRef.consensusData != null
394 && aa.groupRef.isShowSequenceLogo())
396 // TODO? group consensus for cDNA complement
397 return AAFrequency.extractProfile(
398 aa.groupRef.consensusData.get(column),
399 aa.groupRef.getIgnoreGapsConsensus());
401 // TODO extend annotation row to enable dynamic and static profile data to
403 if (aa.groupRef == null && aa.sequenceRef == null)
407 return AAFrequency.extractCdnaProfile(complementConsensus[column],
408 av_ignoreGapsConsensus);
412 return AAFrequency.extractProfile(hconsensus.get(column),
413 av_ignoreGapsConsensus);
419 if (aa.autoCalculated && aa.label.startsWith("StrucConsensus"))
421 // TODO implement group structure consensus
423 * if (aa.groupRef != null && aa.groupRef.consensusData != null &&
424 * aa.groupRef.isShowSequenceLogo()) { //TODO check what happens for
425 * group selections return StructureFrequency.extractProfile(
426 * aa.groupRef.consensusData[column], aa.groupRef
427 * .getIgnoreGapsConsensus()); }
429 // TODO extend annotation row to enable dynamic and static profile data
432 if (aa.groupRef == null && aa.sequenceRef == null
433 && hStrucConsensus != null
434 && hStrucConsensus.length > column)
436 return StructureFrequency.extractProfile(hStrucConsensus[column],
437 av_ignoreGapsConsensus);
446 private AnnotationRendererFactoryI rendererFactoryI;
449 * Render the annotation rows associated with an alignment.
454 * data and view settings to render
456 * destination for graphics
458 * row where a mouse event occured (or -1)
460 * first column that will be drawn
462 * last column that will be drawn
463 * @return true if the fadedImage was used for any alignment annotation rows
464 * currently being calculated
466 public boolean drawComponent(AwtRenderPanelI annotPanel,
467 AlignViewportI av, Graphics g, int activeRow, int startRes,
470 if (g instanceof EpsGraphics2D || g instanceof SVGGraphics2D)
472 this.setVectorRendition(true);
474 Graphics2D g2d = (Graphics2D) g;
476 long stime = System.currentTimeMillis();
477 boolean usedFaded = false;
479 // AnnotationPanel needs to implement: ImageObserver, access to
481 updateFromAwtRenderPanel(annotPanel, av);
482 fm = g.getFontMetrics();
483 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
494 boolean validRes = false;
495 boolean validEnd = false;
496 boolean labelAllCols = false;
497 // boolean centreColLabels;
498 // boolean centreColLabelsDef = av.isCentreColumnLabels();
499 boolean scaleColLabel = false;
500 final AlignmentAnnotation consensusAnnot = av
501 .getAlignmentConsensusAnnotation();
502 final AlignmentAnnotation structConsensusAnnot = av
503 .getAlignmentStrucConsensusAnnotation();
504 final AlignmentAnnotation complementConsensusAnnot = av
505 .getComplementConsensusAnnotation();
507 BitSet graphGroupDrawn = new BitSet();
508 int charOffset = 0; // offset for a label
511 int yfrom = 0, f_i = 0, yto = 0, f_to = 0;
512 boolean clipst = false, clipend = false;
513 for (int i = 0; i < aa.length; i++)
515 AlignmentAnnotation row = aa[i];
516 boolean renderHistogram = true;
517 boolean renderProfile = false;
518 boolean normaliseProfile = false;
519 boolean isRNA = row.isRNA();
521 // check if this is a consensus annotation row and set the display
522 // settings appropriately
523 // TODO: generalise this to have render styles for consensus/profile
525 if (row.groupRef != null && row == row.groupRef.getConsensus())
527 renderHistogram = row.groupRef.isShowConsensusHistogram();
528 renderProfile = row.groupRef.isShowSequenceLogo();
529 normaliseProfile = row.groupRef.isNormaliseSequenceLogo();
531 else if (row == consensusAnnot || row == structConsensusAnnot
532 || row == complementConsensusAnnot)
534 renderHistogram = av_renderHistogram;
535 renderProfile = av_renderProfile;
536 normaliseProfile = av_normaliseProfile;
539 Annotation[] row_annotations = row.annotations;
544 // centreColLabels = row.centreColLabels || centreColLabelsDef;
545 labelAllCols = row.showAllColLabels;
546 scaleColLabel = row.scaleColLabel;
550 if (!useClip || ((y - charHeight) < visHeight
551 && (y + row.height + charHeight * 2) >= sOffset))
552 {// if_in_visible_region
563 if (row.graphGroup > -1 && graphGroupDrawn.get(row.graphGroup))
568 // this is so that we draw the characters below the graph
573 iconOffset = charHeight - fm.getDescent();
577 else if (row.hasText)
579 iconOffset = charHeight - fm.getDescent();
587 if (row.autoCalculated && av.isCalculationInProgress(row))
591 g.drawImage(fadedImage, 0, y - row.height, imgWidth, y, 0,
592 y - row.height, imgWidth, y, annotationPanel);
593 g.setColor(Color.black);
594 // g.drawString("Calculating "+aa[i].label+"....",20, y-row.height/2);
600 * else if (annotationPanel.av.updatingConservation &&
601 * aa[i].label.equals("Conservation")) {
603 * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
604 * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
605 * annotationPanel.imgWidth, y, annotationPanel);
607 * g.setColor(Color.black); //
608 * g.drawString("Calculating Conservation.....",20, y-row.height/2);
610 * continue; } else if (annotationPanel.av.updatingConservation &&
611 * aa[i].label.equals("Quality")) {
613 * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
614 * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
615 * annotationPanel.imgWidth, y, annotationPanel);
616 * g.setColor(Color.black); // /
617 * g.drawString("Calculating Quality....",20, y-row.height/2);
622 // first pass sets up state for drawing continuation from left-hand
626 // flag used for vector rendition
627 this.glyphLineDrawn = false;
628 x = (startRes == 0) ? 0 : -1;
629 while (x < endRes - startRes)
631 if (hasHiddenColumns)
633 column = hiddenColumns.visibleToAbsoluteColumn(startRes + x);
634 if (column > row_annotations.length - 1)
641 column = startRes + x;
644 if ((row_annotations == null)
645 || (row_annotations.length <= column)
646 || (row_annotations[column] == null))
654 final String displayChar = validRes
655 ? row_annotations[column].displayCharacter
662 g.setColor(Color.red);
664 if (columnSelection != null)
666 if (columnSelection.contains(column))
668 fillRect(g, x * charWidth, y, charWidth, charHeight);
672 if (row.getInvalidStrucPos() > x)
674 g.setColor(Color.orange);
675 fillRect(g, x * charWidth, y, charWidth, charHeight);
677 else if (row.getInvalidStrucPos() == x)
679 g.setColor(Color.orange.darker());
680 fillRect(g, x * charWidth, y, charWidth, charHeight);
682 if (validCharWidth && validRes && displayChar != null
683 && (displayChar.length() > 0))
685 // Graphics2D gg = (g);
686 float fmWidth = fm.charsWidth(displayChar.toCharArray(), 0,
687 displayChar.length());
690 * shrink label width to fit in column, if that is
691 * both configured and necessary
693 boolean scaledToFit = false;
694 float fmScaling = 1f;
695 if (scaleColLabel && fmWidth > charWidth)
698 fmScaling = charWidth;
699 fmScaling /= fmWidth;
700 // and update the label's width to reflect the scaling.
704 charOffset = (int) ((charWidth - fmWidth) / 2f);
706 if (row_annotations[column].colour == null)
708 g2d.setColor(Color.black);
712 g2d.setColor(row_annotations[column].colour);
716 * draw the label, unless it is the same secondary structure
717 * symbol (excluding RNA Helix) as the previous column
719 final int xPos = (x * charWidth) + charOffset;
720 final int yPos = y + iconOffset;
723 * translate to drawing position _before_ applying any scaling
725 g2d.translate(xPos, yPos);
729 * use a scaling transform to make the label narrower
730 * (JalviewJS doesn't have Font.deriveFont(AffineTransform))
733 AffineTransform.getScaleInstance(fmScaling, 1.0));
736 if (column == 0 || row.graph > 0)
738 g2d.drawString(displayChar, 0, 0);
740 else if (row_annotations[column - 1] == null || (labelAllCols
741 || !displayChar.equals(
742 row_annotations[column - 1].displayCharacter)
743 || (displayChar.length() < 2
744 && row_annotations[column].secondaryStructure == ' ')))
746 g2d.drawString(displayChar, 0, 0);
751 * undo scaling before translating back
752 * (restoring saved transform does NOT work in JS PDFGraphics!)
754 g2d.transform(AffineTransform
755 .getScaleInstance(1D / fmScaling, 1.0));
757 g2d.translate(-xPos, -yPos);
762 char ss = validRes ? row_annotations[column].secondaryStructure
767 // distinguish between forward/backward base-pairing
768 if (displayChar.indexOf(')') > -1)
777 if ((displayChar.indexOf(']') > -1))
785 // distinguish between forward/backward base-pairing
786 if (displayChar.indexOf('}') > -1)
794 // distinguish between forward/backward base-pairing
795 if (displayChar.indexOf('<') > -1)
801 if (isRNA && (ss >= CHAR_A) && (ss <= CHAR_Z))
803 // distinguish between forward/backward base-pairing
804 int ssLowerCase = ss + UPPER_TO_LOWER;
805 // TODO would .equals() be safer here? or charAt(0)?
806 if (displayChar.indexOf(ssLowerCase) > -1)
808 ss = (char) ssLowerCase;
812 if (!validRes || (ss != lastSS))
818 // int nb_annot = x - temp;
819 // Console.info("\t type :"+lastSS+"\t x
821 // annot :"+nb_annot);
824 case '(': // Stem case for RNA secondary structure
825 case ')': // and opposite direction
826 drawStemAnnot(g, row_annotations, lastSSX, x, y,
827 iconOffset, startRes, column, validRes, validEnd);
834 drawHelixAnnot(g, row_annotations, lastSSX, x, y,
835 iconOffset, startRes, column, validRes,
839 // no break if isRNA - falls through to drawNotCanonicalAnnot!
843 drawSheetAnnot(g, row_annotations, lastSSX, x, y,
844 iconOffset, startRes, column, validRes,
848 // no break if isRNA - fall through to drawNotCanonicalAnnot!
907 Color nonCanColor = getNotCanonicalColor(lastSS);
908 drawNotCanonicalAnnot(g, nonCanColor, row_annotations,
909 lastSSX, x, y, iconOffset, startRes, column,
914 if (isVectorRendition())
916 // draw single full width glyphline
917 drawGlyphLine(g, lastSSX, endRes - x, y, iconOffset);
918 // disable more glyph lines
919 this.glyphLineDrawn = true;
923 drawGlyphLine(g, lastSSX, x, y, iconOffset);
938 lastSSX = (x * charWidth);
945 if (column >= row_annotations.length)
947 column = row_annotations.length - 1;
954 if ((row_annotations == null) || (row_annotations.length <= column)
955 || (row_annotations[column] == null))
973 drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
974 startRes, column, validRes, validEnd);
977 // no break if isRNA - fall through to drawNotCanonicalAnnot!
982 drawSheetAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
983 startRes, column, validRes, validEnd);
986 // no break if isRNA - fall through to drawNotCanonicalAnnot!
989 case ')': // Stem case for RNA secondary structure
991 drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
992 startRes, column, validRes, validEnd);
1049 // Console.info(lastSS);
1050 Color nonCanColor = getNotCanonicalColor(lastSS);
1051 drawNotCanonicalAnnot(g, nonCanColor, row_annotations, lastSSX,
1052 x, y, iconOffset, startRes, column, validRes, validEnd);
1055 if (isVectorRendition())
1057 // draw single full width glyphline
1058 drawGlyphLine(g, lastSSX, endRes - x, y, iconOffset);
1059 // disable more glyph lines
1060 this.glyphLineDrawn = true;
1064 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1070 if (row.graph > 0 && row.graphHeight > 0)
1072 if (row.graph == AlignmentAnnotation.LINE_GRAPH)
1074 if (row.graphGroup > -1 && !graphGroupDrawn.get(row.graphGroup))
1076 // TODO: JAL-1291 revise rendering model so the graphGroup map is
1077 // computed efficiently for all visible labels
1078 float groupmax = -999999, groupmin = 9999999;
1079 for (int gg = 0; gg < aa.length; gg++)
1081 if (aa[gg].graphGroup != row.graphGroup)
1088 aa[gg].visible = false;
1090 if (aa[gg].graphMax > groupmax)
1092 groupmax = aa[gg].graphMax;
1094 if (aa[gg].graphMin < groupmin)
1096 groupmin = aa[gg].graphMin;
1100 for (int gg = 0; gg < aa.length; gg++)
1102 if (aa[gg].graphGroup == row.graphGroup)
1104 drawLineGraph(g, aa[gg], aa[gg].annotations, startRes,
1105 endRes, y, groupmin, groupmax, row.graphHeight);
1109 graphGroupDrawn.set(row.graphGroup);
1113 drawLineGraph(g, row, row_annotations, startRes, endRes, y,
1114 row.graphMin, row.graphMax, row.graphHeight);
1117 else if (row.graph == AlignmentAnnotation.BAR_GRAPH)
1119 drawBarGraph(g, row, row_annotations, startRes, endRes,
1120 row.graphMin, row.graphMax, y, renderHistogram,
1121 renderProfile, normaliseProfile);
1125 AnnotationRowRendererI renderer = rendererFactoryI
1126 .getRendererFor(row);
1127 if (renderer != null)
1129 renderer.renderRow(g, charWidth, charHeight, hasHiddenColumns,
1130 av, hiddenColumns, columnSelection, row,
1131 row_annotations, startRes, endRes, row.graphMin,
1136 if (renderer == null)
1139 .println("No renderer found for " + row.toString());
1144 "rendered with " + renderer.getClass().toString());
1153 if (clipst && !clipend)
1157 } // end if_in_visible_region
1158 if (row.graph > 0 && row.hasText)
1174 Console.warn("Start clip at : " + yfrom + " (index " + f_i + ")");
1178 Console.warn("End clip at : " + yto + " (index " + f_to + ")");
1182 Console.warn("Annotation Rendering time:"
1183 + (System.currentTimeMillis() - stime));
1190 public static final Color GLYPHLINE_COLOR = Color.gray;
1192 public static final Color SHEET_COLOUR = Color.green;
1194 public static final Color HELIX_COLOUR = Color.red;
1196 public static final Color STEM_COLOUR = Color.blue;
1198 // private Color sdNOTCANONICAL_COLOUR;
1200 void drawGlyphLine(Graphics g, int lastSSX, int x, int y, int iconOffset)
1204 // if we've drawn a single long glyphline for an export, don't draw the
1209 g.setColor(GLYPHLINE_COLOR);
1210 g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth) - lastSSX, 2);
1213 void drawSheetAnnot(Graphics g, Annotation[] row,
1215 int lastSSX, int x, int y, int iconOffset, int startRes,
1216 int column, boolean validRes, boolean validEnd)
1218 if (!validEnd || !validRes || row == null || row[column] == null
1219 || row[column].secondaryStructure != 'E')
1221 // draw the glyphline underneath
1222 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1224 g.setColor(SHEET_COLOUR);
1225 fillRect(g, lastSSX, y + 4 + iconOffset,
1226 (x * charWidth) - lastSSX - 4, 6);
1229 { (x * charWidth) - 6, (x * charWidth) - 6,
1230 (x * charWidth - 1) },
1232 { y + iconOffset + 1, y + 13 + iconOffset,
1233 y + 7 + iconOffset },
1238 g.setColor(SHEET_COLOUR);
1239 fillRect(g, lastSSX, y + 4 + iconOffset, (x * charWidth) - lastSSX,
1244 void drawHelixAnnot(Graphics g, Annotation[] row, int lastSSX, int x,
1245 int y, int iconOffset, int startRes, int column, boolean validRes,
1248 int sCol = (lastSSX / charWidth)
1249 + hiddenColumns.visibleToAbsoluteColumn(startRes);
1251 int x2 = (x * charWidth);
1253 if (USE_FILL_ROUND_RECT || isVectorRendition())
1255 // draw glyph line behind helix (visible in EPS or SVG output)
1256 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1258 g.setColor(HELIX_COLOUR);
1260 int ofs = charWidth / 2;
1261 // Off by 1 offset when drawing rects and ovals
1262 // to offscreen image on the MAC
1263 fillRoundRect(g, lastSSX, y + 3 + iconOffset, x2 - x1 - 1, 8, 8, 8);
1264 if (sCol == 0 || row[sCol - 1] == null
1265 || row[sCol - 1].secondaryStructure != 'H')
1270 // g.setColor(Color.orange);
1271 fillRoundRect(g, lastSSX, y + 3 + iconOffset, x2 - x1 - ofs, 8, 0,
1274 if (!validRes || row[column] == null
1275 || row[column].secondaryStructure != 'H')
1281 // g.setColor(Color.magenta);
1282 fillRoundRect(g, lastSSX + ofs, y + 3 + iconOffset, x2 - x1 - ofs,
1289 boolean leftEnd = sCol == 0 || row[sCol - 1] == null
1290 || row[sCol - 1].secondaryStructure != 'H';
1291 boolean rightEnd = !validRes || row[column] == null
1292 || row[column].secondaryStructure != 'H';
1294 if (leftEnd || rightEnd)
1296 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1298 g.setColor(HELIX_COLOUR);
1302 fillArc(g, lastSSX, y + 3 + iconOffset, charWidth, 8, 90, 180);
1303 x1 += charWidth / 2;
1308 fillArc(g, ((x - 1) * charWidth), y + 3 + iconOffset, charWidth, 8,
1310 x2 -= charWidth / 2;
1313 fillRect(g, x1, y + 3 + iconOffset, x2 - x1, 8);
1316 void drawLineGraph(Graphics g, AlignmentAnnotation _aa,
1317 Annotation[] aa_annotations, int sRes, int eRes, int y, float min,
1318 float max, int graphHeight)
1320 if (sRes > aa_annotations.length)
1324 Stroke roundStroke = new BasicStroke(1, BasicStroke.CAP_ROUND,
1325 BasicStroke.JOIN_ROUND);
1326 Stroke squareStroke = new BasicStroke(1, BasicStroke.CAP_SQUARE,
1327 BasicStroke.JOIN_MITER);
1328 Graphics2D g2d = (Graphics2D) g;
1329 Stroke prevStroke = g2d.getStroke();
1330 g2d.setStroke(roundStroke);
1334 // Adjustment for fastpaint to left
1340 eRes = Math.min(eRes, aa_annotations.length);
1348 float range = max - min;
1353 y2 = y - (int) ((0 - min / range) * graphHeight);
1356 g.setColor(Color.gray);
1357 drawLine(g, squareStroke, x * charWidth - charWidth, y2,
1358 (eRes - sRes) * charWidth, y2);
1360 eRes = Math.min(eRes, aa_annotations.length);
1363 int aaMax = aa_annotations.length - 1;
1365 while (x < eRes - sRes)
1368 if (hasHiddenColumns)
1370 column = hiddenColumns.visibleToAbsoluteColumn(column);
1378 if (aa_annotations[column] == null)
1384 if (aa_annotations[column].colour == null)
1386 g.setColor(Color.black);
1390 g.setColor(aa_annotations[column].colour);
1393 if (aa_annotations[column - 1] == null
1394 && aa_annotations.length > column + 1
1395 && aa_annotations[column + 1] == null)
1398 y1 = y - (int) (((aa_annotations[column].value - min) / range)
1400 drawLine(g, x * charWidth + charWidth / 4, y1,
1401 x * charWidth + 3 * charWidth / 4, y1);
1406 if (aa_annotations[column - 1] == null)
1412 y1 = y - (int) (((aa_annotations[column - 1].value - min) / range)
1414 y2 = y - (int) (((aa_annotations[column].value - min) / range)
1417 drawLine(g, (x - 1) * charWidth + charWidth / 2, y1,
1418 x * charWidth + charWidth / 2, y2);
1422 if (_aa.threshold != null)
1424 g.setColor(_aa.threshold.colour);
1425 Graphics2D g2 = (Graphics2D) g;
1426 Stroke s = new BasicStroke(1, BasicStroke.CAP_SQUARE,
1427 BasicStroke.JOIN_ROUND, 3f, new float[]
1430 y2 = (int) (y - ((_aa.threshold.value - min) / range) * graphHeight);
1431 drawLine(g, s, 0, y2, (eRes - sRes) * charWidth, y2);
1433 g2d.setStroke(prevStroke);
1436 @SuppressWarnings("unused")
1437 void drawBarGraph(Graphics g, AlignmentAnnotation _aa,
1438 Annotation[] aa_annotations, int sRes, int eRes, float min,
1439 float max, int y, boolean renderHistogram, boolean renderProfile,
1440 boolean normaliseProfile)
1442 if (sRes > aa_annotations.length)
1446 Font ofont = g.getFont();
1447 eRes = Math.min(eRes, aa_annotations.length);
1449 int x = 0, y1 = y, y2 = y;
1451 float range = max - min;
1455 y2 = y - (int) ((0 - min / (range)) * _aa.graphHeight);
1458 g.setColor(Color.gray);
1460 drawLine(g, x, y2, (eRes - sRes) * charWidth, y2);
1463 int aaMax = aa_annotations.length - 1;
1464 while (x < eRes - sRes)
1467 if (hasHiddenColumns)
1469 column = hiddenColumns.visibleToAbsoluteColumn(column);
1477 if (aa_annotations[column] == null)
1482 if (aa_annotations[column].colour == null)
1484 g.setColor(Color.black);
1488 g.setColor(aa_annotations[column].colour);
1491 y1 = y - (int) (((aa_annotations[column].value - min) / (range))
1494 if (renderHistogram)
1498 fillRect(g, x * charWidth, y2, charWidth, y1 - y2);
1502 fillRect(g, x * charWidth, y1, charWidth, y2 - y1);
1505 // draw profile if available
1510 * {profile type, #values, total count, char1, pct1, char2, pct2...}
1512 int profl[] = getProfileFor(_aa, column);
1514 // just try to draw the logo if profl is not null
1515 if (profl != null && profl[2] != 0)
1517 boolean isStructureProfile = profl[0] == AlignmentAnnotation.STRUCTURE_PROFILE;
1518 boolean isCdnaProfile = profl[0] == AlignmentAnnotation.CDNA_PROFILE;
1519 float ht = normaliseProfile ? y - _aa.graphHeight : y1;
1520 final double normaliseFactor = normaliseProfile ? _aa.graphHeight
1524 * Render a single base for a sequence profile, a base pair for
1525 * structure profile, and a triplet for a cdna profile
1527 char[] dc = new char[isStructureProfile ? 2
1528 : (isCdnaProfile ? 3 : 1)];
1530 // lm is not necessary - we can just use fm - could be off by no more
1532 // LineMetrics lm = g.getFontMetrics(ofont).getLineMetrics("Q", g);
1533 // Console.info(asc + " " + dec + " " + (asc -
1535 // + " " + (dec - lm.getDescent()));
1537 double asc = fm.getAscent();
1538 double dec = fm.getDescent();
1539 double fht = fm.getHeight();
1541 double scale = 1f / (normaliseProfile ? profl[2] : 100f);
1542 // float ofontHeight = 1f / fm.getAscent();// magnify to fill box
1545 * Traverse the character(s)/percentage data in the array
1550 // profl[1] is the number of values in the profile
1551 for (int i = 0, c = 3, last = profl[1]; i < last; i++)
1555 if (isStructureProfile)
1557 // todo can we encode a structure pair as an int, like codons?
1558 dc[0] = (char) profl[c++];
1559 dc[1] = (char) profl[c++];
1562 else if (isCdnaProfile)
1564 CodingUtils.decodeCodon2(profl[c++], dc);
1569 dc[0] = (char) profl[c++];
1572 // next profl[] position is profile % for the character(s)
1574 int percent = profl[c++];
1577 // failsafe in case a count rounds down to 0%
1580 double newHeight = normaliseFactor * scale * percent;
1583 * Set character colour as per alignment colour scheme; use the
1584 * codon translation if a cDNA profile
1586 Color colour = null;
1589 final String codonTranslation = ResidueProperties
1591 colour = profcolour.findColour(codonTranslation.charAt(0),
1596 colour = profcolour.findColour(dc[0], column, null);
1598 g.setColor(colour == Color.white ? Color.lightGray : colour);
1600 // Debug - render boxes around characters
1601 // g.setColor(Color.red);
1602 // g.drawRect(x*av.charWidth, (int)ht, av.charWidth,
1604 // g.setColor(profcolour.findColour(dc[0]).darker());
1606 double sx = 1f * charWidth / fm.charsWidth(dc, 0, dc.length);
1607 double sy = newHeight / asc;
1608 double newAsc = asc * sy;
1609 double newDec = dec * sy;
1610 // it is not necessary to recalculate lm for the new font.
1611 // note: lm.getBaselineOffsets()[lm.getBaselineIndex()]) must be 0
1612 // by definition. Was:
1613 // int hght = (int) (ht + (newAsc - newDec);
1614 // - lm.getBaselineOffsets()[lm.getBaselineIndex()]));
1616 if (Platform.isJS())
1619 * SwingJS does not implement font.deriveFont()
1620 * so use a scaling transform to draw instead,
1621 * this is off by a very small amount
1623 final int hght = (int) (ht2 + (newAsc - newDec));
1624 Graphics2D gg = (Graphics2D) g;
1625 int xShift = (int) Math.round(x * charWidth / sx);
1626 int yShift = (int) Math.round(hght / sy);
1627 gg.transform(AffineTransform.getScaleInstance(sx, sy));
1628 gg.drawString(s, xShift, yShift);
1630 AffineTransform.getScaleInstance(1D / sx, 1D / sy));
1640 // Java ('normal') method is to scale the font to fit
1642 final int hght = (int) (ht + (newAsc - newDec));
1644 .deriveFont(AffineTransform.getScaleInstance(sx, sy));
1646 g.drawChars(dc, 0, dc.length, x * charWidth, hght);
1656 if (_aa.threshold != null)
1658 g.setColor(_aa.threshold.colour);
1659 Stroke s = new BasicStroke(1, BasicStroke.CAP_SQUARE,
1660 BasicStroke.JOIN_ROUND, 3f, new float[]
1664 - ((_aa.threshold.value - min) / range) * _aa.graphHeight);
1665 drawLine(g, s, 0, y2, (eRes - sRes) * charWidth, y2);
1669 // used by overview window
1670 public void drawGraph(Graphics g, AlignmentAnnotation _aa,
1671 Annotation[] aa_annotations, int width, int y, int sRes, int eRes)
1673 eRes = Math.min(eRes, aa_annotations.length);
1674 g.setColor(Color.white);
1675 fillRect(g, 0, 0, width, y);
1676 g.setColor(new Color(0, 0, 180));
1680 for (int j = sRes; j < eRes; j++)
1682 if (aa_annotations[j] != null)
1684 if (aa_annotations[j].colour == null)
1686 g.setColor(Color.black);
1690 g.setColor(aa_annotations[j].colour);
1693 height = (int) ((aa_annotations[j].value / _aa.graphMax) * y);
1699 fillRect(g, x, y - height, charWidth, height);
1705 Color getNotCanonicalColor(char lastss)
1711 return new Color(255, 125, 5);
1715 return new Color(245, 115, 10);
1719 return new Color(235, 135, 15);
1723 return new Color(225, 105, 20);
1727 return new Color(215, 145, 30);
1731 return new Color(205, 95, 35);
1735 return new Color(195, 155, 45);
1739 return new Color(185, 85, 55);
1743 return new Color(175, 165, 65);
1747 return new Color(170, 75, 75);
1751 return new Color(160, 175, 85);
1755 return new Color(150, 65, 95);
1759 return new Color(140, 185, 105);
1763 return new Color(130, 55, 110);
1767 return new Color(120, 195, 120);
1771 return new Color(110, 45, 130);
1775 return new Color(100, 205, 140);
1779 return new Color(90, 35, 150);
1783 return new Color(85, 215, 160);
1787 return new Color(75, 25, 170);
1791 return new Color(65, 225, 180);
1795 return new Color(55, 15, 185);
1799 return new Color(45, 235, 195);
1803 return new Color(35, 5, 205);
1807 return new Color(25, 245, 215);
1811 return new Color(15, 0, 225);
1815 return new Color(10, 255, 235);
1819 return new Color(5, 150, 245);
1823 return new Color(0, 80, 255);
1826 Console.info("This is not a interaction : " + lastss);
1832 private void fillPolygon(Graphics g, int[] xpoints, int[] ypoints, int n)
1835 g.fillPolygon(xpoints, ypoints, n);
1839 private void fillRect(Graphics g, int a, int b, int c, int d)
1841 fillRect(g, false, a, b, c, d);
1844 private void fillRect(Graphics g, int a, int b, int c, int d)
1847 g.fillRect(a, b, c, d);
1850 private void fillRoundRect(Graphics g, int a, int b, int c, int d, int e,
1854 g.fillRoundRect(a, b, c, d, e, f);
1857 private void fillArc(Graphics g, int a, int b, int c, int d, int e, int f)
1860 g.fillArc(a, b, c, d, e, f);
1863 private void drawLine(Graphics g, Stroke s, int a, int b, int c, int d)
1865 Graphics2D g2d = (Graphics2D) g;
1866 Stroke p = g2d.getStroke();
1868 drawLine(g, a, b, c, d);
1872 private void drawLine(Graphics g, int a, int b, int c, int d)
1875 g.drawLine(a, b, c, d);
1878 private void setAntialias(Graphics g)
1880 if (isVectorRendition())
1882 // no need to antialias vector drawings
1885 if (Cache.getDefault("ANTI_ALIAS", true))
1887 Graphics2D g2d = (Graphics2D) g;
1888 g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1889 RenderingHints.VALUE_ANTIALIAS_ON);
1893 private void unsetAntialias(Graphics g)
1895 if (isVectorRendition())
1897 // no need to antialias vector drawings
1900 Graphics2D g2d = (Graphics2D) g;
1901 g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1902 RenderingHints.VALUE_ANTIALIAS_OFF);
1905 public void setVectorRendition(boolean b)
1907 vectorRendition = b;
1910 public boolean isVectorRendition()
1912 return vectorRendition;