/*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.gui;
-import java.awt.*;
+import jalview.api.AlignViewportI;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.renderer.ResidueShaderI;
+import jalview.renderer.seqfeatures.FeatureColourFinder;
+import jalview.util.Comparison;
-import jalview.datamodel.*;
-import jalview.schemes.*;
+import java.awt.Color;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
-/**
- * DOCUMENT ME!
- *
- * @author $author$
- * @version $Revision$
- */
-public class SequenceRenderer
+public class SequenceRenderer implements jalview.api.SequenceRenderer
{
- AlignViewport av;
+ final static int CHAR_TO_UPPER = 'A' - 'a';
+
+ AlignViewportI av;
FontMetrics fm;
boolean forOverview = false;
/**
- * Creates a new SequenceRenderer object.
+ * Creates a new SequenceRenderer object
*
- * @param av
- * DOCUMENT ME!
+ * @param viewport
*/
- public SequenceRenderer(AlignViewport av)
+ public SequenceRenderer(AlignViewportI viewport)
{
- this.av = av;
+ this.av = viewport;
}
/**
* DOCUMENT ME!
*
* @param b
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void prepare(Graphics g, boolean renderGaps)
{
// If EPS graphics, stringWidth will be a double, not an int
double dwidth = fm.getStringBounds("M", g).getWidth();
- monospacedFont = (dwidth == fm.getStringBounds("|", g).getWidth() && (float) av.charWidth == dwidth);
+ monospacedFont = (dwidth == fm.getStringBounds("|", g).getWidth() && av
+ .getCharWidth() == dwidth);
this.renderGaps = renderGaps;
}
- public Color getResidueBoxColour(SequenceI seq, int i)
+ protected Color getResidueBoxColour(SequenceI seq, int i)
{
- allGroups = av.alignment.findAllGroups(seq);
+ // rate limiting step when rendering overview for lots of groups
+ allGroups = av.getAlignment().findAllGroups(seq);
if (inCurrentSequenceGroup(i))
{
if (currentSequenceGroup.getDisplayBoxes())
{
- getBoxColour(currentSequenceGroup.cs, seq, i);
+ getBoxColour(currentSequenceGroup.getGroupColourScheme(), seq, i);
}
}
else if (av.getShowBoxes())
{
- getBoxColour(av.globalColourScheme, seq, i);
+ getBoxColour(av.getResidueShading(), seq, i);
}
return resBoxColour;
}
/**
+ * Get the residue colour at the given sequence position - as determined by
+ * the sequence group colour (if any), else the colour scheme, possibly
+ * overridden by a feature colour.
+ *
+ * @param seq
+ * @param position
+ * @param finder
+ * @return
+ */
+ @Override
+ public Color getResidueColour(final SequenceI seq, int position,
+ FeatureColourFinder finder)
+ {
+ Color col = getResidueBoxColour(seq, position);
+
+ if (finder != null)
+ {
+ col = finder.findFeatureColour(col, seq, position);
+ }
+ return col;
+ }
+
+ /**
* DOCUMENT ME!
*
- * @param cs
- * DOCUMENT ME!
+ * @param shader
+ * DOCUMENT ME!
* @param seq
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param i
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
- void getBoxColour(ColourSchemeI cs, SequenceI seq, int i)
+ void getBoxColour(ResidueShaderI shader, SequenceI seq, int i)
{
- if (cs != null)
+ if (shader.getColourScheme() != null)
{
- resBoxColour = cs.findColour(seq.getCharAt(i), i);
+ resBoxColour = shader.findColour(seq.getCharAt(i),
+ i, seq);
}
- else if (forOverview
- && !jalview.util.Comparison.isGap(seq.getCharAt(i)))
+ else if (forOverview && !Comparison.isGap(seq.getCharAt(i)))
{
resBoxColour = Color.lightGray;
}
* DOCUMENT ME!
*
* @param g
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param seq
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param sg
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param start
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param end
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param x1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param y1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param width
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param height
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void drawSequence(SequenceI seq, SequenceGroup[] sg, int start,
int end, int y1)
drawBoxes(seq, start, end, y1);
- if (av.validCharWidth)
+ if (av.isValidCharWidth())
{
drawText(seq, start, end, y1);
}
* DOCUMENT ME!
*
* @param seq
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param start
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param end
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param x1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param y1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param width
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param height
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public synchronized void drawBoxes(SequenceI seq, int start, int end,
int y1)
{
+ if (seq == null)
+ {
+ return; // fix for racecondition
+ }
int i = start;
int length = seq.getLength();
int curStart = -1;
- int curWidth = av.charWidth;
+ int curWidth = av.getCharWidth(), avWidth = av.getCharWidth(), avHeight = av
+ .getCharHeight();
Color tempColour = null;
{
if (currentSequenceGroup.getDisplayBoxes())
{
- getBoxColour(currentSequenceGroup.cs, seq, i);
+ getBoxColour(currentSequenceGroup.getGroupColourScheme(), seq,
+ i);
}
}
else if (av.getShowBoxes())
{
- getBoxColour(av.globalColourScheme, seq, i);
+ getBoxColour(av.getResidueShading(), seq, i);
}
-
}
if (resBoxColour != tempColour)
{
if (tempColour != null)
{
- graphics.fillRect(av.charWidth * (curStart - start), y1,
- curWidth, av.charHeight);
+ graphics.fillRect(avWidth * (curStart - start), y1, curWidth,
+ avHeight);
}
graphics.setColor(resBoxColour);
curStart = i;
- curWidth = av.charWidth;
+ curWidth = avWidth;
tempColour = resBoxColour;
}
else
{
- curWidth += av.charWidth;
+ curWidth += avWidth;
}
i++;
}
- graphics.fillRect(av.charWidth * (curStart - start), y1, curWidth,
- av.charHeight);
+ graphics.fillRect(avWidth * (curStart - start), y1, curWidth, avHeight);
}
* DOCUMENT ME!
*
* @param seq
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param start
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param end
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param x1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param y1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param width
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param height
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void drawText(SequenceI seq, int start, int end, int y1)
{
- y1 += av.charHeight - av.charHeight / 5; // height/5 replaces pady
+ y1 += av.getCharHeight() - av.getCharHeight() / 5; // height/5 replaces pady
int charOffset = 0;
char s;
{
end = seq.getLength() - 1;
}
- graphics.setColor(av.textColour);
+ graphics.setColor(av.getTextColour());
- if (monospacedFont && av.showText && allGroups.length == 0
- && !av.getColourText() && av.thresholdTextColour == 0)
+ if (monospacedFont && av.getShowText() && allGroups.length == 0
+ && !av.getColourText() && av.getThresholdTextColour() == 0)
{
- if (av.renderGaps)
+ if (av.isRenderGaps())
{
graphics.drawString(seq.getSequenceAsString(start, end + 1), 0, y1);
}
}
else
{
+ boolean srep = av.isDisplayReferenceSeq();
boolean getboxColour = false;
+ boolean isarep = av.getAlignment().getSeqrep() == seq;
+ boolean isgrep = currentSequenceGroup != null ? currentSequenceGroup
+ .getSeqrep() == seq : false;
+ char sr_c;
for (int i = start; i <= end; i++)
{
- graphics.setColor(av.textColour);
+
+ graphics.setColor(av.getTextColour());
getboxColour = false;
s = seq.getCharAt(i);
+
if (!renderGaps && jalview.util.Comparison.isGap(s))
{
continue;
|| currentSequenceGroup.getColourText())
{
getboxColour = true;
- getBoxColour(currentSequenceGroup.cs, seq, i);
+ getBoxColour(currentSequenceGroup.getGroupColourScheme(), seq,
+ i);
if (currentSequenceGroup.getColourText())
{
{
graphics.setColor(currentSequenceGroup.textColour);
}
- if (currentSequenceGroup.getShowunconserved()) // todo optimize
+ if (!isarep && !isgrep
+ && currentSequenceGroup.getShowNonconserved()) // todo
+ // optimize
{
// todo - use sequence group consensus
- s = getDisplayChar(av.consensus, i, s, '.');
-
+ s = getDisplayChar(srep, i, s, '.', currentSequenceGroup);
+
}
}
if (av.getColourText())
{
getboxColour = true;
- getBoxColour(av.globalColourScheme, seq, i);
+ getBoxColour(av.getResidueShading(), seq, i);
if (av.getShowBoxes())
{
}
}
- if (av.thresholdTextColour > 0)
+ if (av.getThresholdTextColour() > 0)
{
if (!getboxColour)
{
- getBoxColour(av.globalColourScheme, seq, i);
+ getBoxColour(av.getResidueShading(), seq, i);
}
if (resBoxColour.getRed() + resBoxColour.getBlue()
- + resBoxColour.getGreen() < av.thresholdTextColour)
+ + resBoxColour.getGreen() < av.getThresholdTextColour())
{
- graphics.setColor(av.textColour2);
+ graphics.setColor(av.getTextColour2());
}
}
- if (av.showUnconserved)
+ if (!isarep && av.getShowUnconserved())
{
- s = getDisplayChar(av.consensus, i, s, '.');
-
+ s = getDisplayChar(srep, i, s, '.', null);
+
}
}
- charOffset = (av.charWidth - fm.charWidth(s)) / 2;
- graphics.drawString(String.valueOf(s), charOffset + av.charWidth
- * (i - start), y1);
+ charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
+ graphics.drawString(String.valueOf(s),
+ charOffset + av.getCharWidth() * (i - start), y1);
}
}
}
- private char getDisplayChar(AlignmentAnnotation consensus, int position, char s, char c)
+
+ /**
+ * Returns 'conservedChar' to represent the given position if the sequence
+ * character at that position is equal to the consensus (ignoring case), else
+ * returns the sequence character
+ *
+ * @param usesrep
+ * @param position
+ * @param sequenceChar
+ * @param conservedChar
+ * @return
+ */
+ private char getDisplayChar(final boolean usesrep, int position,
+ char sequenceChar, char conservedChar, SequenceGroup currentGroup)
{
- char conschar = consensus.annotations[position].displayCharacter.charAt(0);
- if (conschar!='-' && s==conschar)
+ // TODO - use currentSequenceGroup rather than alignment
+ // currentSequenceGroup.getConsensus()
+ char conschar = (usesrep) ? (currentGroup == null
+ || position < currentGroup.getStartRes()
+ || position > currentGroup.getEndRes() ? av.getAlignment()
+ .getSeqrep().getCharAt(position)
+ : (currentGroup.getSeqrep() != null ? currentGroup.getSeqrep()
+ .getCharAt(position) : av.getAlignment().getSeqrep()
+ .getCharAt(position)))
+ : (currentGroup != null && currentGroup.getConsensus() != null
+ && position >= currentGroup.getStartRes()
+ && position <= currentGroup.getEndRes() && currentGroup
+ .getConsensus().annotations.length > position) ? currentGroup
+ .getConsensus().annotations[position].displayCharacter
+ .charAt(0)
+ : av.getAlignmentConsensusAnnotation().annotations[position].displayCharacter
+ .charAt(0);
+ if (!jalview.util.Comparison.isGap(conschar)
+ && (sequenceChar == conschar || sequenceChar + CHAR_TO_UPPER == conschar))
{
- s= c;
+ sequenceChar = conservedChar;
}
- return s;
+ return sequenceChar;
}
/**
* DOCUMENT ME!
*
* @param res
- * DOCUMENT ME!
+ * DOCUMENT ME!
*
* @return DOCUMENT ME!
*/
* DOCUMENT ME!
*
* @param seq
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param start
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param end
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param x1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param y1
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param width
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param height
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void drawHighlightedText(SequenceI seq, int start, int end,
int x1, int y1)
{
- int pady = av.charHeight / 5;
+ int pady = av.getCharHeight() / 5;
int charOffset = 0;
graphics.setColor(Color.BLACK);
- graphics.fillRect(x1, y1, av.charWidth * (end - start + 1),
- av.charHeight);
+ graphics.fillRect(x1, y1, av.getCharWidth() * (end - start + 1),
+ av.getCharHeight());
graphics.setColor(Color.white);
char s = '~';
// Need to find the sequence position here.
- if (av.validCharWidth)
+ if (av.isValidCharWidth())
{
for (int i = start; i <= end; i++)
{
s = seq.getCharAt(i);
}
- charOffset = (av.charWidth - fm.charWidth(s)) / 2;
- graphics
- .drawString(String.valueOf(s), charOffset + x1
- + (av.charWidth * (i - start)),
- (y1 + av.charHeight) - pady);
+ charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
+ graphics.drawString(String.valueOf(s),
+ charOffset + x1 + (av.getCharWidth() * (i - start)),
+ (y1 + av.getCharHeight()) - pady);
}
}
}
public void drawCursor(SequenceI seq, int res, int x1, int y1)
{
- int pady = av.charHeight / 5;
+ int pady = av.getCharHeight() / 5;
int charOffset = 0;
graphics.setColor(Color.black);
- graphics.fillRect(x1, y1, av.charWidth, av.charHeight);
+ graphics.fillRect(x1, y1, av.getCharWidth(), av.getCharHeight());
- if (av.validCharWidth)
+ if (av.isValidCharWidth())
{
graphics.setColor(Color.white);
char s = seq.getCharAt(res);
- charOffset = (av.charWidth - fm.charWidth(s)) / 2;
+ charOffset = (av.getCharWidth() - fm.charWidth(s)) / 2;
graphics.drawString(String.valueOf(s), charOffset + x1,
- (y1 + av.charHeight) - pady);
+ (y1 + av.getCharHeight()) - pady);
}
}