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 int sCol = (lastSSX / charWidth)
179 + hiddenColumns.visibleToAbsoluteColumn(startRes);
181 int x2 = (x * charWidth);
183 char dc = (column == 0 || row_annotations[column - 1] == null) ? ' '
184 : row_annotations[column - 1].secondaryStructure;
186 boolean diffupstream = sCol == 0 || row_annotations[sCol - 1] == null
187 || dc != row_annotations[sCol - 1].secondaryStructure;
188 boolean diffdownstream = !validRes || !validEnd
189 || row_annotations[column] == null
190 || dc != row_annotations[column].secondaryStructure;
192 if (diffupstream || diffdownstream)
194 // draw glyphline under arrow
195 drawGlyphLine(g, lastSSX, x, y, iconOffset);
197 g.setColor(STEM_COLOUR);
199 if (column > 0 && Rna.isClosingParenthesis(dc))
202 // if (validRes && column>1 && row_annotations[column-2]!=null &&
203 // dc.equals(row_annotations[column-2].displayCharacter))
206 * if new annotation with a closing base pair half of the stem,
207 * display a backward arrow
209 fillPolygon(g, new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
211 { y + iconOffset + 1, y + 13 + iconOffset,
212 y + 7 + iconOffset },
223 // display a forward arrow
227 * if annotation ending with an opeing base pair half of the stem,
228 * display a forward arrow
230 fillPolygon(g, new int[] { x2 - 6, x2 - 6, x2 - 1 },
232 { y + iconOffset + 1, y + 13 + iconOffset,
233 y + 7 + iconOffset },
244 fillRect(g, x1, y + 4 + iconOffset, x2 - x1, 6);
247 void drawNotCanonicalAnnot(Graphics g, Color nonCanColor,
248 Annotation[] row_annotations, int lastSSX, int x, int y,
249 int iconOffset, int startRes, int column, boolean validRes,
252 // Console.info(nonCanColor);
254 int sCol = (lastSSX / charWidth)
255 + hiddenColumns.visibleToAbsoluteColumn(startRes);
257 int x2 = (x * charWidth);
259 String dc = (column == 0 || row_annotations[column - 1] == null) ? ""
260 : row_annotations[column - 1].displayCharacter;
262 boolean diffupstream = sCol == 0 || row_annotations[sCol - 1] == null
263 || !dc.equals(row_annotations[sCol - 1].displayCharacter);
264 boolean diffdownstream = !validRes || !validEnd
265 || row_annotations[column] == null
266 || !dc.equals(row_annotations[column].displayCharacter);
267 // Console.info("Column "+column+" diff up:
269 // down:"+diffdownstream);
270 // If a closing base pair half of the stem, display a backward arrow
271 if (diffupstream || diffdownstream)
273 // draw glyphline under arrow
274 drawGlyphLine(g, lastSSX, x, y, iconOffset);
276 g.setColor(nonCanColor);
277 if (column > 0 && Rna.isClosingParenthesis(dc))
281 // if (validRes && column>1 && row_annotations[column-2]!=null &&
282 // dc.equals(row_annotations[column-2].displayCharacter))
284 fillPolygon(g, new int[] { lastSSX + 5, lastSSX + 5, lastSSX },
286 { y + iconOffset + 1, y + 13 + iconOffset,
287 y + 7 + iconOffset },
299 // display a forward arrow
302 fillPolygon(g, new int[] { x2 - 6, x2 - 6, x2 - 1 },
304 { y + iconOffset + 1, y + 13 + iconOffset,
305 y + 7 + iconOffset },
316 fillRect(g, x1, y + 4 + iconOffset, x2 - x1, 6);
319 // public void updateFromAnnotationPanel(FontMetrics annotFM, AlignViewportI
321 public void updateFromAwtRenderPanel(AwtRenderPanelI annotPanel,
324 fm = annotPanel.getFontMetrics();
325 annotationPanel = annotPanel;
326 fadedImage = annotPanel.getFadedImage();
327 imgWidth = annotPanel.getFadedImageWidth();
328 // visible area for rendering
329 int[] bounds = annotPanel.getVisibleVRange();
333 visHeight = bounds[1];
348 rendererFactoryI = AnnotationRendererFactory.getRendererFactory();
349 updateFromAlignViewport(av);
352 public void updateFromAlignViewport(AlignViewportI av)
354 charWidth = av.getCharWidth();
355 endRes = av.getRanges().getEndRes();
356 charHeight = av.getCharHeight();
357 hasHiddenColumns = av.hasHiddenColumns();
358 validCharWidth = av.isValidCharWidth();
359 av_renderHistogram = av.isShowConsensusHistogram();
360 av_renderProfile = av.isShowSequenceLogo();
361 av_normaliseProfile = av.isNormaliseSequenceLogo();
362 profcolour = av.getResidueShading();
363 if (profcolour == null || profcolour.getColourScheme() == null)
366 * Use default colour for sequence logo if
367 * the alignment has no colourscheme set
368 * (would like to use user preference but n/a for applet)
370 ColourSchemeI col = av.getAlignment().isNucleotide()
371 ? new NucleotideColourScheme()
372 : new ZappoColourScheme();
373 profcolour = new ResidueShader(col);
375 columnSelection = av.getColumnSelection();
376 hiddenColumns = av.getAlignment().getHiddenColumns();
377 hconsensus = av.getSequenceConsensusHash();
378 complementConsensus = av.getComplementConsensusHash();
379 hStrucConsensus = av.getRnaStructureConsensusHash();
380 av_ignoreGapsConsensus = av.isIgnoreGapsConsensus();
384 * Returns profile data; the first element is the profile type, the second is
385 * the number of distinct values, the third the total count, and the remainder
386 * depend on the profile type.
392 int[] getProfileFor(AlignmentAnnotation aa, int column)
394 // TODO : consider refactoring the global alignment calculation
395 // properties/rendering attributes as a global 'alignment group' which holds
396 // all vis settings for the alignment as a whole rather than a subset
398 if (aa.autoCalculated && (aa.label.startsWith("Consensus")
399 || aa.label.startsWith("cDNA Consensus")))
401 boolean forComplement = aa.label.startsWith("cDNA Consensus");
402 if (aa.groupRef != null && aa.groupRef.consensusData != null
403 && aa.groupRef.isShowSequenceLogo())
405 // TODO? group consensus for cDNA complement
406 return AAFrequency.extractProfile(
407 aa.groupRef.consensusData.get(column),
408 aa.groupRef.getIgnoreGapsConsensus());
410 // TODO extend annotation row to enable dynamic and static profile data to
412 if (aa.groupRef == null && aa.sequenceRef == null)
416 return AAFrequency.extractCdnaProfile(complementConsensus[column],
417 av_ignoreGapsConsensus);
421 return AAFrequency.extractProfile(hconsensus.get(column),
422 av_ignoreGapsConsensus);
428 if (aa.autoCalculated && aa.label.startsWith("StrucConsensus"))
430 // TODO implement group structure consensus
432 * if (aa.groupRef != null && aa.groupRef.consensusData != null &&
433 * aa.groupRef.isShowSequenceLogo()) { //TODO check what happens for
434 * group selections return StructureFrequency.extractProfile(
435 * aa.groupRef.consensusData[column], aa.groupRef
436 * .getIgnoreGapsConsensus()); }
438 // TODO extend annotation row to enable dynamic and static profile data
441 if (aa.groupRef == null && aa.sequenceRef == null
442 && hStrucConsensus != null
443 && hStrucConsensus.length > column)
445 return StructureFrequency.extractProfile(hStrucConsensus[column],
446 av_ignoreGapsConsensus);
455 private AnnotationRendererFactoryI rendererFactoryI;
458 * Render the annotation rows associated with an alignment.
463 * data and view settings to render
465 * destination for graphics
467 * row where a mouse event occured (or -1)
469 * first column that will be drawn
471 * last column that will be drawn
472 * @return true if the fadedImage was used for any alignment annotation rows
473 * currently being calculated
475 public boolean drawComponent(AwtRenderPanelI annotPanel,
476 AlignViewportI av, Graphics g, int activeRow, int startRes,
479 if (g instanceof EpsGraphics2D || g instanceof SVGGraphics2D)
481 this.setVectorRendition(true);
483 Graphics2D g2d = (Graphics2D) g;
485 long stime = System.currentTimeMillis();
486 boolean usedFaded = false;
488 // AnnotationPanel needs to implement: ImageObserver, access to
490 updateFromAwtRenderPanel(annotPanel, av);
491 fm = g.getFontMetrics();
492 AlignmentAnnotation[] aa = av.getAlignment().getAlignmentAnnotation();
503 boolean validRes = false;
504 boolean validEnd = false;
505 boolean labelAllCols = false;
506 // boolean centreColLabels;
507 // boolean centreColLabelsDef = av.isCentreColumnLabels();
508 boolean scaleColLabel = false;
509 final AlignmentAnnotation consensusAnnot = av
510 .getAlignmentConsensusAnnotation();
511 final AlignmentAnnotation structConsensusAnnot = av
512 .getAlignmentStrucConsensusAnnotation();
513 final AlignmentAnnotation complementConsensusAnnot = av
514 .getComplementConsensusAnnotation();
516 BitSet graphGroupDrawn = new BitSet();
517 int charOffset = 0; // offset for a label
520 int yfrom = 0, f_i = 0, yto = 0, f_to = 0;
521 boolean clipst = false, clipend = false;
522 for (int i = 0; i < aa.length; i++)
524 AlignmentAnnotation row = aa[i];
525 boolean renderHistogram = true;
526 boolean renderProfile = false;
527 boolean normaliseProfile = false;
528 boolean isRNA = row.isRNA();
530 // check if this is a consensus annotation row and set the display
531 // settings appropriately
532 // TODO: generalise this to have render styles for consensus/profile
534 if (row.groupRef != null && row == row.groupRef.getConsensus())
536 renderHistogram = row.groupRef.isShowConsensusHistogram();
537 renderProfile = row.groupRef.isShowSequenceLogo();
538 normaliseProfile = row.groupRef.isNormaliseSequenceLogo();
540 else if (row == consensusAnnot || row == structConsensusAnnot
541 || row == complementConsensusAnnot)
543 renderHistogram = av_renderHistogram;
544 renderProfile = av_renderProfile;
545 normaliseProfile = av_normaliseProfile;
548 Annotation[] row_annotations = row.annotations;
553 // centreColLabels = row.centreColLabels || centreColLabelsDef;
554 labelAllCols = row.showAllColLabels;
555 scaleColLabel = row.scaleColLabel;
559 if (!useClip || ((y - charHeight) < visHeight
560 && (y + row.height + charHeight * 2) >= sOffset))
561 {// if_in_visible_region
572 if (row.graphGroup > -1 && graphGroupDrawn.get(row.graphGroup))
577 // this is so that we draw the characters below the graph
582 iconOffset = charHeight - fm.getDescent();
586 else if (row.hasText)
588 iconOffset = charHeight - fm.getDescent();
596 if (row.autoCalculated && av.isCalculationInProgress(row))
600 g.drawImage(fadedImage, 0, y - row.height, imgWidth, y, 0,
601 y - row.height, imgWidth, y, annotationPanel);
602 g.setColor(Color.black);
603 // g.drawString("Calculating "+aa[i].label+"....",20, y-row.height/2);
609 * else if (annotationPanel.av.updatingConservation &&
610 * aa[i].label.equals("Conservation")) {
612 * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
613 * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
614 * annotationPanel.imgWidth, y, annotationPanel);
616 * g.setColor(Color.black); //
617 * g.drawString("Calculating Conservation.....",20, y-row.height/2);
619 * continue; } else if (annotationPanel.av.updatingConservation &&
620 * aa[i].label.equals("Quality")) {
622 * y += charHeight; g.drawImage(annotationPanel.fadedImage, 0, y -
623 * row.height, annotationPanel.imgWidth, y, 0, y - row.height,
624 * annotationPanel.imgWidth, y, annotationPanel);
625 * g.setColor(Color.black); // /
626 * g.drawString("Calculating Quality....",20, y-row.height/2);
631 // first pass sets up state for drawing continuation from left-hand
635 // flag used for vector rendition
636 this.glyphLineDrawn = false;
637 x = (startRes == 0) ? 0 : -1;
638 while (x < endRes - startRes)
640 if (hasHiddenColumns)
642 column = hiddenColumns.visibleToAbsoluteColumn(startRes + x);
643 if (column > row_annotations.length - 1)
650 column = startRes + x;
653 if ((row_annotations == null)
654 || (row_annotations.length <= column)
655 || (row_annotations[column] == null))
663 final String displayChar = validRes
664 ? row_annotations[column].displayCharacter
671 g.setColor(Color.red);
673 if (columnSelection != null)
675 if (columnSelection.contains(column))
677 fillRect(g, x * charWidth, y, charWidth, charHeight);
681 if (row.getInvalidStrucPos() > x)
683 g.setColor(Color.orange);
684 fillRect(g, x * charWidth, y, charWidth, charHeight);
686 else if (row.getInvalidStrucPos() == x)
688 g.setColor(Color.orange.darker());
689 fillRect(g, x * charWidth, y, charWidth, charHeight);
691 if (validCharWidth && validRes && displayChar != null
692 && (displayChar.length() > 0))
694 // Graphics2D gg = (g);
695 float fmWidth = fm.charsWidth(displayChar.toCharArray(), 0,
696 displayChar.length());
699 * shrink label width to fit in column, if that is
700 * both configured and necessary
702 boolean scaledToFit = false;
703 float fmScaling = 1f;
704 if (scaleColLabel && fmWidth > charWidth)
707 fmScaling = charWidth;
708 fmScaling /= fmWidth;
709 // and update the label's width to reflect the scaling.
713 charOffset = (int) ((charWidth - fmWidth) / 2f);
715 if (row_annotations[column].colour == null)
717 g2d.setColor(Color.black);
721 g2d.setColor(row_annotations[column].colour);
725 * draw the label, unless it is the same secondary structure
726 * symbol (excluding RNA Helix) as the previous column
728 final int xPos = (x * charWidth) + charOffset;
729 final int yPos = y + iconOffset;
732 * translate to drawing position _before_ applying any scaling
734 g2d.translate(xPos, yPos);
738 * use a scaling transform to make the label narrower
739 * (JalviewJS doesn't have Font.deriveFont(AffineTransform))
742 AffineTransform.getScaleInstance(fmScaling, 1.0));
745 if (column == 0 || row.graph > 0)
747 g2d.drawString(displayChar, 0, 0);
749 else if (row_annotations[column - 1] == null || (labelAllCols
750 || !displayChar.equals(
751 row_annotations[column - 1].displayCharacter)
752 || (displayChar.length() < 2
753 && row_annotations[column].secondaryStructure == ' ')))
755 g2d.drawString(displayChar, 0, 0);
760 * undo scaling before translating back
761 * (restoring saved transform does NOT work in JS PDFGraphics!)
763 g2d.transform(AffineTransform
764 .getScaleInstance(1D / fmScaling, 1.0));
766 g2d.translate(-xPos, -yPos);
771 char ss = validRes ? row_annotations[column].secondaryStructure
776 // distinguish between forward/backward base-pairing
777 if (displayChar.indexOf(')') > -1)
786 if ((displayChar.indexOf(']') > -1))
794 // distinguish between forward/backward base-pairing
795 if (displayChar.indexOf('}') > -1)
803 // distinguish between forward/backward base-pairing
804 if (displayChar.indexOf('<') > -1)
810 if (isRNA && (ss >= CHAR_A) && (ss <= CHAR_Z))
812 // distinguish between forward/backward base-pairing
813 int ssLowerCase = ss + UPPER_TO_LOWER;
814 // TODO would .equals() be safer here? or charAt(0)?
815 if (displayChar.indexOf(ssLowerCase) > -1)
817 ss = (char) ssLowerCase;
821 if (!validRes || (ss != lastSS))
827 // int nb_annot = x - temp;
828 // Console.info("\t type :"+lastSS+"\t x
830 // annot :"+nb_annot);
833 case '(': // Stem case for RNA secondary structure
834 case ')': // and opposite direction
835 drawStemAnnot(g, row_annotations, lastSSX, x, y,
836 iconOffset, startRes, column, validRes, validEnd);
843 drawHelixAnnot(g, row_annotations, lastSSX, x, y,
844 iconOffset, startRes, column, validRes,
848 // no break if isRNA - falls through to drawNotCanonicalAnnot!
852 drawSheetAnnot(g, row_annotations, lastSSX, x, y,
853 iconOffset, startRes, column, validRes,
857 // no break if isRNA - fall through to drawNotCanonicalAnnot!
916 Color nonCanColor = getNotCanonicalColor(lastSS);
917 drawNotCanonicalAnnot(g, nonCanColor, row_annotations,
918 lastSSX, x, y, iconOffset, startRes, column,
923 if (isVectorRendition())
925 // draw single full width glyphline
926 drawGlyphLine(g, lastSSX, endRes - x, y, iconOffset);
927 // disable more glyph lines
928 this.glyphLineDrawn = true;
932 drawGlyphLine(g, lastSSX, x, y, iconOffset);
947 lastSSX = (x * charWidth);
954 if (column >= row_annotations.length)
956 column = row_annotations.length - 1;
963 if ((row_annotations == null) || (row_annotations.length <= column)
964 || (row_annotations[column] == null))
982 drawHelixAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
983 startRes, column, validRes, validEnd);
986 // no break if isRNA - fall through to drawNotCanonicalAnnot!
991 drawSheetAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
992 startRes, column, validRes, validEnd);
995 // no break if isRNA - fall through to drawNotCanonicalAnnot!
998 case ')': // Stem case for RNA secondary structure
1000 drawStemAnnot(g, row_annotations, lastSSX, x, y, iconOffset,
1001 startRes, column, validRes, validEnd);
1058 // Console.info(lastSS);
1059 Color nonCanColor = getNotCanonicalColor(lastSS);
1060 drawNotCanonicalAnnot(g, nonCanColor, row_annotations, lastSSX,
1061 x, y, iconOffset, startRes, column, validRes, validEnd);
1064 if (isVectorRendition())
1066 // draw single full width glyphline
1067 drawGlyphLine(g, lastSSX, endRes - x, y, iconOffset);
1068 // disable more glyph lines
1069 this.glyphLineDrawn = true;
1073 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1079 if (row.graph > 0 && row.graphHeight > 0)
1081 if (row.graph == AlignmentAnnotation.LINE_GRAPH)
1083 if (row.graphGroup > -1 && !graphGroupDrawn.get(row.graphGroup))
1085 // TODO: JAL-1291 revise rendering model so the graphGroup map is
1086 // computed efficiently for all visible labels
1087 float groupmax = -999999, groupmin = 9999999;
1088 for (int gg = 0; gg < aa.length; gg++)
1090 if (aa[gg].graphGroup != row.graphGroup)
1097 aa[gg].visible = false;
1099 if (aa[gg].graphMax > groupmax)
1101 groupmax = aa[gg].graphMax;
1103 if (aa[gg].graphMin < groupmin)
1105 groupmin = aa[gg].graphMin;
1109 for (int gg = 0; gg < aa.length; gg++)
1111 if (aa[gg].graphGroup == row.graphGroup)
1113 drawLineGraph(g, aa[gg], aa[gg].annotations, startRes,
1114 endRes, y, groupmin, groupmax, row.graphHeight);
1118 graphGroupDrawn.set(row.graphGroup);
1122 drawLineGraph(g, row, row_annotations, startRes, endRes, y,
1123 row.graphMin, row.graphMax, row.graphHeight);
1126 else if (row.graph == AlignmentAnnotation.BAR_GRAPH)
1128 drawBarGraph(g, row, row_annotations, startRes, endRes,
1129 row.graphMin, row.graphMax, y, renderHistogram,
1130 renderProfile, normaliseProfile);
1134 AnnotationRowRendererI renderer = rendererFactoryI
1135 .getRendererFor(row);
1136 if (renderer != null)
1138 renderer.renderRow(g, charWidth, charHeight, hasHiddenColumns,
1139 av, hiddenColumns, columnSelection, row,
1140 row_annotations, startRes, endRes, row.graphMin,
1145 if (renderer == null)
1148 .println("No renderer found for " + row.toString());
1153 "rendered with " + renderer.getClass().toString());
1162 if (clipst && !clipend)
1166 } // end if_in_visible_region
1167 if (row.graph > 0 && row.hasText)
1183 Console.warn("Start clip at : " + yfrom + " (index " + f_i + ")");
1187 Console.warn("End clip at : " + yto + " (index " + f_to + ")");
1191 Console.warn("Annotation Rendering time:"
1192 + (System.currentTimeMillis() - stime));
1199 public static final Color GLYPHLINE_COLOR = Color.gray;
1201 public static final Color SHEET_COLOUR = Color.green;
1203 public static final Color HELIX_COLOUR = Color.red;
1205 public static final Color STEM_COLOUR = Color.blue;
1207 // private Color sdNOTCANONICAL_COLOUR;
1209 void drawGlyphLine(Graphics g, int lastSSX, int x, int y, int iconOffset)
1213 // if we've drawn a single long glyphline for an export, don't draw the
1218 g.setColor(GLYPHLINE_COLOR);
1219 g.fillRect(lastSSX, y + 6 + iconOffset, (x * charWidth) - lastSSX, 2);
1222 void drawSheetAnnot(Graphics g, Annotation[] row,
1224 int lastSSX, int x, int y, int iconOffset, int startRes,
1225 int column, boolean validRes, boolean validEnd)
1227 if (!validEnd || !validRes || row == null || row[column] == null
1228 || row[column].secondaryStructure != 'E')
1230 // draw the glyphline underneath
1231 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1233 g.setColor(SHEET_COLOUR);
1234 fillRect(g, lastSSX, y + 4 + iconOffset,
1235 (x * charWidth) - lastSSX - 4, 6);
1238 { (x * charWidth) - 6, (x * charWidth) - 6,
1239 (x * charWidth - 1) },
1241 { y + iconOffset + 1, y + 13 + iconOffset,
1242 y + 7 + iconOffset },
1247 g.setColor(SHEET_COLOUR);
1248 fillRect(g, lastSSX, y + 4 + iconOffset, (x * charWidth) - lastSSX,
1253 void drawHelixAnnot(Graphics g, Annotation[] row, int lastSSX, int x,
1254 int y, int iconOffset, int startRes, int column, boolean validRes,
1257 int sCol = (lastSSX / charWidth)
1258 + hiddenColumns.visibleToAbsoluteColumn(startRes);
1260 int x2 = (x * charWidth);
1262 if (USE_FILL_ROUND_RECT || isVectorRendition())
1264 // draw glyph line behind helix (visible in EPS or SVG output)
1265 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1267 g.setColor(HELIX_COLOUR);
1269 int ofs = charWidth / 2;
1270 // Off by 1 offset when drawing rects and ovals
1271 // to offscreen image on the MAC
1272 fillRoundRect(g, lastSSX, y + 3 + iconOffset, x2 - x1 - 1, 8, 8, 8);
1273 if (sCol == 0 || row[sCol - 1] == null
1274 || row[sCol - 1].secondaryStructure != 'H')
1279 fillRoundRect(g, lastSSX, y + 3 + iconOffset, x2 - x1 - ofs, 8, 0,
1282 if (!validRes || row[column] == null
1283 || row[column].secondaryStructure != 'H')
1289 fillRoundRect(g, lastSSX + ofs, y + 3 + iconOffset, x2 - x1 - ofs,
1296 boolean leftEnd = sCol == 0 || row[sCol - 1] == null
1297 || row[sCol - 1].secondaryStructure != 'H';
1298 boolean rightEnd = !validRes || row[column] == null
1299 || row[column].secondaryStructure != 'H';
1301 if (leftEnd || rightEnd)
1303 drawGlyphLine(g, lastSSX, x, y, iconOffset);
1305 g.setColor(HELIX_COLOUR);
1309 fillArc(g, lastSSX, y + 3 + iconOffset, charWidth, 8, 90, 180);
1310 x1 += charWidth / 2;
1315 fillArc(g, ((x - 1) * charWidth), y + 3 + iconOffset, charWidth, 8,
1317 x2 -= charWidth / 2;
1320 fillRect(g, x1, y + 3 + iconOffset, x2 - x1, 8);
1323 void drawLineGraph(Graphics g, AlignmentAnnotation _aa,
1324 Annotation[] aa_annotations, int sRes, int eRes, int y, float min,
1325 float max, int graphHeight)
1327 if (sRes > aa_annotations.length)
1331 Stroke roundStroke = new BasicStroke(1, BasicStroke.CAP_ROUND,
1332 BasicStroke.JOIN_ROUND);
1333 Stroke squareStroke = new BasicStroke(1, BasicStroke.CAP_SQUARE,
1334 BasicStroke.JOIN_MITER);
1335 Graphics2D g2d = (Graphics2D) g;
1336 Stroke prevStroke = g2d.getStroke();
1337 g2d.setStroke(roundStroke);
1341 // Adjustment for fastpaint to left
1347 eRes = Math.min(eRes, aa_annotations.length);
1355 float range = max - min;
1360 y2 = y - (int) ((0 - min / range) * graphHeight);
1363 g.setColor(Color.gray);
1364 drawLine(g, squareStroke, x * charWidth - charWidth, y2,
1365 (eRes - sRes) * charWidth, y2);
1367 eRes = Math.min(eRes, aa_annotations.length);
1370 int aaMax = aa_annotations.length - 1;
1372 while (x < eRes - sRes)
1375 if (hasHiddenColumns)
1377 column = hiddenColumns.visibleToAbsoluteColumn(column);
1385 if (aa_annotations[column] == null)
1391 if (aa_annotations[column].colour == null)
1393 g.setColor(Color.black);
1397 g.setColor(aa_annotations[column].colour);
1400 if (aa_annotations[column - 1] == null
1401 && aa_annotations.length > column + 1
1402 && aa_annotations[column + 1] == null)
1405 y1 = y - (int) (((aa_annotations[column].value - min) / range)
1407 drawLine(g, x * charWidth + charWidth / 4, y1,
1408 x * charWidth + 3 * charWidth / 4, y1);
1413 if (aa_annotations[column - 1] == null)
1419 y1 = y - (int) (((aa_annotations[column - 1].value - min) / range)
1421 y2 = y - (int) (((aa_annotations[column].value - min) / range)
1424 drawLine(g, (x - 1) * charWidth + charWidth / 2, y1,
1425 x * charWidth + charWidth / 2, y2);
1429 if (_aa.threshold != null)
1431 g.setColor(_aa.threshold.colour);
1432 Graphics2D g2 = (Graphics2D) g;
1433 Stroke s = new BasicStroke(1, BasicStroke.CAP_SQUARE,
1434 BasicStroke.JOIN_ROUND, 3f, new float[]
1437 y2 = (int) (y - ((_aa.threshold.value - min) / range) * graphHeight);
1438 drawLine(g, s, 0, y2, (eRes - sRes) * charWidth, y2);
1440 g2d.setStroke(prevStroke);
1443 @SuppressWarnings("unused")
1444 void drawBarGraph(Graphics g, AlignmentAnnotation _aa,
1445 Annotation[] aa_annotations, int sRes, int eRes, float min,
1446 float max, int y, boolean renderHistogram, boolean renderProfile,
1447 boolean normaliseProfile)
1449 if (sRes > aa_annotations.length)
1453 Font ofont = g.getFont();
1454 eRes = Math.min(eRes, aa_annotations.length);
1456 int x = 0, y1 = y, y2 = y;
1458 float range = max - min;
1462 y2 = y - (int) ((0 - min / (range)) * _aa.graphHeight);
1465 g.setColor(Color.gray);
1467 drawLine(g, x, y2, (eRes - sRes) * charWidth, y2);
1470 int aaMax = aa_annotations.length - 1;
1471 while (x < eRes - sRes)
1474 if (hasHiddenColumns)
1476 column = hiddenColumns.visibleToAbsoluteColumn(column);
1484 if (aa_annotations[column] == null)
1489 if (aa_annotations[column].colour == null)
1491 g.setColor(Color.black);
1495 g.setColor(aa_annotations[column].colour);
1498 y1 = y - (int) (((aa_annotations[column].value - min) / (range))
1501 if (renderHistogram)
1505 fillRect(g, x * charWidth, y2, charWidth, y1 - y2);
1509 fillRect(g, x * charWidth, y1, charWidth, y2 - y1);
1512 // draw profile if available
1517 * {profile type, #values, total count, char1, pct1, char2, pct2...}
1519 int profl[] = getProfileFor(_aa, column);
1521 // just try to draw the logo if profl is not null
1522 if (profl != null && profl[2] != 0)
1524 boolean isStructureProfile = profl[0] == AlignmentAnnotation.STRUCTURE_PROFILE;
1525 boolean isCdnaProfile = profl[0] == AlignmentAnnotation.CDNA_PROFILE;
1526 float ht = normaliseProfile ? y - _aa.graphHeight : y1;
1527 final double normaliseFactor = normaliseProfile ? _aa.graphHeight
1531 * Render a single base for a sequence profile, a base pair for
1532 * structure profile, and a triplet for a cdna profile
1534 char[] dc = new char[isStructureProfile ? 2
1535 : (isCdnaProfile ? 3 : 1)];
1537 // lm is not necessary - we can just use fm - could be off by no more
1539 // LineMetrics lm = g.getFontMetrics(ofont).getLineMetrics("Q", g);
1540 // Console.info(asc + " " + dec + " " + (asc -
1542 // + " " + (dec - lm.getDescent()));
1544 double asc = fm.getAscent();
1545 double dec = fm.getDescent();
1546 double fht = fm.getHeight();
1548 double scale = 1f / (normaliseProfile ? profl[2] : 100f);
1549 // float ofontHeight = 1f / fm.getAscent();// magnify to fill box
1552 * Traverse the character(s)/percentage data in the array
1557 // profl[1] is the number of values in the profile
1558 for (int i = 0, c = 3, last = profl[1]; i < last; i++)
1562 if (isStructureProfile)
1564 // todo can we encode a structure pair as an int, like codons?
1565 dc[0] = (char) profl[c++];
1566 dc[1] = (char) profl[c++];
1569 else if (isCdnaProfile)
1571 CodingUtils.decodeCodon2(profl[c++], dc);
1576 dc[0] = (char) profl[c++];
1579 // next profl[] position is profile % for the character(s)
1581 int percent = profl[c++];
1584 // failsafe in case a count rounds down to 0%
1587 double newHeight = normaliseFactor * scale * percent;
1590 * Set character colour as per alignment colour scheme; use the
1591 * codon translation if a cDNA profile
1593 Color colour = null;
1596 final String codonTranslation = ResidueProperties
1598 colour = profcolour.findColour(codonTranslation.charAt(0),
1603 colour = profcolour.findColour(dc[0], column, null);
1605 g.setColor(colour == Color.white ? Color.lightGray : colour);
1607 // Debug - render boxes around characters
1608 // g.setColor(Color.red);
1609 // g.drawRect(x*av.charWidth, (int)ht, av.charWidth,
1611 // g.setColor(profcolour.findColour(dc[0]).darker());
1613 double sx = 1f * charWidth / fm.charsWidth(dc, 0, dc.length);
1614 double sy = newHeight / asc;
1615 double newAsc = asc * sy;
1616 double newDec = dec * sy;
1617 // it is not necessary to recalculate lm for the new font.
1618 // note: lm.getBaselineOffsets()[lm.getBaselineIndex()]) must be 0
1619 // by definition. Was:
1620 // int hght = (int) (ht + (newAsc - newDec);
1621 // - lm.getBaselineOffsets()[lm.getBaselineIndex()]));
1623 if (Platform.isJS())
1626 * SwingJS does not implement font.deriveFont()
1627 * so use a scaling transform to draw instead,
1628 * this is off by a very small amount
1630 final int hght = (int) (ht2 + (newAsc - newDec));
1631 Graphics2D gg = (Graphics2D) g;
1632 int xShift = (int) Math.round(x * charWidth / sx);
1633 int yShift = (int) Math.round(hght / sy);
1634 gg.transform(AffineTransform.getScaleInstance(sx, sy));
1635 gg.drawString(s, xShift, yShift);
1637 AffineTransform.getScaleInstance(1D / sx, 1D / sy));
1647 // Java ('normal') method is to scale the font to fit
1649 final int hght = (int) (ht + (newAsc - newDec));
1651 .deriveFont(AffineTransform.getScaleInstance(sx, sy));
1653 g.drawChars(dc, 0, dc.length, x * charWidth, hght);
1663 if (_aa.threshold != null)
1665 g.setColor(_aa.threshold.colour);
1666 Stroke s = new BasicStroke(1, BasicStroke.CAP_SQUARE,
1667 BasicStroke.JOIN_ROUND, 3f, new float[]
1671 - ((_aa.threshold.value - min) / range) * _aa.graphHeight);
1672 drawLine(g, s, 0, y2, (eRes - sRes) * charWidth, y2);
1676 // used by overview window
1677 public void drawGraph(Graphics g, AlignmentAnnotation _aa,
1678 Annotation[] aa_annotations, int width, int y, int sRes, int eRes)
1680 eRes = Math.min(eRes, aa_annotations.length);
1681 g.setColor(Color.white);
1682 fillRect(g, 0, 0, width, y);
1683 g.setColor(new Color(0, 0, 180));
1687 for (int j = sRes; j < eRes; j++)
1689 if (aa_annotations[j] != null)
1691 if (aa_annotations[j].colour == null)
1693 g.setColor(Color.black);
1697 g.setColor(aa_annotations[j].colour);
1700 height = (int) ((aa_annotations[j].value / _aa.graphMax) * y);
1706 fillRect(g, x, y - height, charWidth, height);
1712 Color getNotCanonicalColor(char lastss)
1718 return new Color(255, 125, 5);
1722 return new Color(245, 115, 10);
1726 return new Color(235, 135, 15);
1730 return new Color(225, 105, 20);
1734 return new Color(215, 145, 30);
1738 return new Color(205, 95, 35);
1742 return new Color(195, 155, 45);
1746 return new Color(185, 85, 55);
1750 return new Color(175, 165, 65);
1754 return new Color(170, 75, 75);
1758 return new Color(160, 175, 85);
1762 return new Color(150, 65, 95);
1766 return new Color(140, 185, 105);
1770 return new Color(130, 55, 110);
1774 return new Color(120, 195, 120);
1778 return new Color(110, 45, 130);
1782 return new Color(100, 205, 140);
1786 return new Color(90, 35, 150);
1790 return new Color(85, 215, 160);
1794 return new Color(75, 25, 170);
1798 return new Color(65, 225, 180);
1802 return new Color(55, 15, 185);
1806 return new Color(45, 235, 195);
1810 return new Color(35, 5, 205);
1814 return new Color(25, 245, 215);
1818 return new Color(15, 0, 225);
1822 return new Color(10, 255, 235);
1826 return new Color(5, 150, 245);
1830 return new Color(0, 80, 255);
1833 Console.info("This is not a interaction : " + lastss);
1839 private void fillPolygon(Graphics g, int[] xpoints, int[] ypoints, int n)
1842 g.fillPolygon(xpoints, ypoints, n);
1846 private void fillRect(Graphics g, int a, int b, int c, int d)
1848 fillRect(g, false, a, b, c, d);
1851 private void fillRect(Graphics g, int a, int b, int c, int d)
1854 g.fillRect(a, b, c, d);
1857 private void fillRoundRect(Graphics g, int a, int b, int c, int d, int e,
1861 g.fillRoundRect(a, b, c, d, e, f);
1864 private void fillArc(Graphics g, int a, int b, int c, int d, int e, int f)
1867 g.fillArc(a, b, c, d, e, f);
1870 private void drawLine(Graphics g, Stroke s, int a, int b, int c, int d)
1872 Graphics2D g2d = (Graphics2D) g;
1873 Stroke p = g2d.getStroke();
1875 drawLine(g, a, b, c, d);
1879 private void drawLine(Graphics g, int a, int b, int c, int d)
1882 g.drawLine(a, b, c, d);
1885 private void setAntialias(Graphics g)
1887 if (isVectorRendition())
1889 // no need to antialias vector drawings
1892 if (Cache.getDefault("ANTI_ALIAS", true))
1894 Graphics2D g2d = (Graphics2D) g;
1895 g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1896 RenderingHints.VALUE_ANTIALIAS_ON);
1900 private void unsetAntialias(Graphics g)
1902 if (isVectorRendition())
1904 // no need to antialias vector drawings
1907 Graphics2D g2d = (Graphics2D) g;
1908 g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
1909 RenderingHints.VALUE_ANTIALIAS_OFF);
1912 public void setVectorRendition(boolean b)
1914 vectorRendition = b;
1917 public boolean isVectorRendition()
1919 return vectorRendition;