src/jalview/gui/FeatureRenderer.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.gui;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import java.awt.*;\r
  24 \r
  25 import java.util.*;\r
  26 \r
  27 import java.awt.image.*;\r
  28 \r
  29 \r
  30 /**\r
  31  * DOCUMENT ME!\r
  32  *\r
  33  * @author $author$\r
  34  * @version $Revision$\r
  35  */\r
  36 public class FeatureRenderer\r
  37 {\r
  38     AlignViewport av;\r
  39     Color resBoxColour;\r
  40     float transparency = 1.0f;\r
  41     FontMetrics fm;\r
  42     int charOffset;\r
  43     boolean drawText = true;\r
  44 \r
  45     // The following vector holds the features which are\r
  46     // to be added, in the correct order or rendering\r
  47     Vector featuresDisplayed = null;\r
  48 \r
  49     /**\r
  50      * Creates a new FeatureRenderer object.\r
  51      *\r
  52      * @param av DOCUMENT ME!\r
  53      */\r
  54     public FeatureRenderer(AlignViewport av)\r
  55     {\r
  56         this.av = av;\r
  57         initColours();\r
  58     }\r
  59 \r
  60     /**\r
  61      * This is used by the Molecule Viewer to get the accurate colour\r
  62      * of the rendered sequence\r
  63      */\r
  64     BufferedImage bi;\r
  65     public Color findFeatureColour(Color initialCol, SequenceI seq, int i)\r
  66     {\r
  67       if(!av.showSequenceFeatures)\r
  68         return initialCol;\r
  69 \r
  70       if (bi == null)\r
  71         bi = new BufferedImage(1, 1, BufferedImage.TYPE_INT_RGB);\r
  72 \r
  73       bi.setRGB(0,0, initialCol.getRGB());\r
  74 \r
  75       drawText = false;\r
  76 \r
  77       drawSequence(bi.getGraphics(), seq, i, i, 0, 0, 1, 1);\r
  78       drawText = true;\r
  79 \r
  80       return new Color(bi.getRGB(0, 0));\r
  81     }\r
  82 \r
  83 \r
  84     /**\r
  85      * DOCUMENT ME!\r
  86      *\r
  87      * @param g DOCUMENT ME!\r
  88      * @param seq DOCUMENT ME!\r
  89      * @param sg DOCUMENT ME!\r
  90      * @param start DOCUMENT ME!\r
  91      * @param end DOCUMENT ME!\r
  92      * @param x1 DOCUMENT ME!\r
  93      * @param y1 DOCUMENT ME!\r
  94      * @param width DOCUMENT ME!\r
  95      * @param height DOCUMENT ME!\r
  96      */\r
  97     public void drawSequence(Graphics g, SequenceI seq,\r
  98                              int start, int end, int x1, int y1, int width, int height)\r
  99     {\r
 100 \r
 101 //System.out.println(start+" "+end+" "+x1+" "+y1);\r
 102       if (seq.getDatasetSequence().getSequenceFeatures() == null\r
 103           || seq.getDatasetSequence().getSequenceFeatures().size()==0)\r
 104         return;\r
 105 \r
 106       fm = g.getFontMetrics();\r
 107 \r
 108       if (transparency != 1)\r
 109       {\r
 110         Graphics2D g2 = (Graphics2D) g;\r
 111         g2.setComposite(\r
 112             AlphaComposite.getInstance(\r
 113                 AlphaComposite.SRC_OVER, transparency));\r
 114       }\r
 115 \r
 116       String type;\r
 117       SequenceFeature sf;\r
 118       if (featuresDisplayed == null)\r
 119         findAllFeatures();\r
 120 \r
 121       Enumeration e = featuresDisplayed.elements(), e2;\r
 122 \r
 123       // Loop through each visible feature\r
 124       while (e.hasMoreElements())\r
 125       {\r
 126 \r
 127         type = e.nextElement().toString();\r
 128         e2 = seq.getDatasetSequence().getSequenceFeatures().elements();\r
 129         // loop through all features in sequence to find\r
 130         // current feature to render\r
 131           while (e2.hasMoreElements())\r
 132         {\r
 133 \r
 134           sf = (SequenceFeature) e2.nextElement();\r
 135           if (!type.equals(sf.getType()))\r
 136             continue;\r
 137 \r
 138           if (sf.getBegin() > seq.getEnd())\r
 139             continue;\r
 140 \r
 141           if (type.equals("disulfide bond"))\r
 142           {\r
 143 \r
 144             renderFeature(g, seq,\r
 145                           seq.findIndex(sf.getBegin()) - 1,\r
 146                           seq.findIndex(sf.getBegin()) - 1,\r
 147                           type, start, end, x1, y1, width, height);\r
 148             renderFeature(g, seq,\r
 149                           seq.findIndex(sf.getEnd()) - 1,\r
 150                           seq.findIndex(sf.getEnd()) - 1,\r
 151                           type, start, end, x1, y1, width, height);\r
 152 \r
 153           }\r
 154           else\r
 155             renderFeature(g, seq,\r
 156                           seq.findIndex(sf.getBegin()) - 1,\r
 157                           seq.findIndex(sf.getEnd()) - 1,\r
 158                           type, start, end, x1, y1, width, height);\r
 159         }\r
 160       }\r
 161 \r
 162         if(transparency!=1.0f)\r
 163         {\r
 164           Graphics2D g2 = (Graphics2D) g;\r
 165           g2.setComposite(\r
 166               AlphaComposite.getInstance(\r
 167                   AlphaComposite.SRC_OVER, 1.0f));\r
 168         }\r
 169     }\r
 170 \r
 171 \r
 172     void renderFeature(Graphics g, SequenceI seq,\r
 173                        int fstart, int fend, String type, int start, int end, int x1, int y1, int width, int height)\r
 174     {\r
 175 \r
 176       if (((fstart <= end) && (fend >= start)))\r
 177       {\r
 178           if (fstart < start)\r
 179           { // fix for if the feature we have starts before the sequence start,\r
 180               fstart = start; // but the feature end is still valid!!\r
 181           }\r
 182 \r
 183           if (fend >= end)\r
 184           {\r
 185             fend = end;\r
 186           }\r
 187           for (int i = fstart; i <= fend; i++)\r
 188           {\r
 189             char s = seq.getSequence().charAt(i);\r
 190 \r
 191             if (jalview.util.Comparison.isGap(s))\r
 192             {\r
 193               continue;\r
 194             }\r
 195 \r
 196             g.setColor(getColour(type));\r
 197 \r
 198             g.fillRect( (i - start) * width, y1, width, height);\r
 199 \r
 200             if(drawText)\r
 201            {\r
 202              g.setColor(Color.white);\r
 203              charOffset = (width - fm.charWidth(s)) / 2;\r
 204              g.drawString(String.valueOf(s),\r
 205                           charOffset + x1 + (width * (i - start)),\r
 206                           (y1 + height) - height / 5); //pady = height / 5;\r
 207            }\r
 208           }\r
 209         }\r
 210     }\r
 211 \r
 212     void findAllFeatures()\r
 213     {\r
 214       Vector features = new Vector();\r
 215       SequenceFeature sf;\r
 216       featuresDisplayed = new Vector();\r
 217       Enumeration e;\r
 218       for (int i = 0; i < av.alignment.getHeight(); i++)\r
 219       {\r
 220         features = av.alignment.getSequenceAt(i).getDatasetSequence().\r
 221             getSequenceFeatures();\r
 222         if (features == null)\r
 223           continue;\r
 224 \r
 225         e = features.elements();\r
 226         while (e.hasMoreElements())\r
 227         {\r
 228           sf = (SequenceFeature) e.nextElement();\r
 229           if (!featuresDisplayed.contains(sf.getType()))\r
 230           {\r
 231             featuresDisplayed.addElement(sf.getType());\r
 232           }\r
 233         }\r
 234       }\r
 235     }\r
 236 \r
 237     public Color getColour(String featureType)\r
 238     {\r
 239       return (Color)featureColours.get(featureType);\r
 240     }\r
 241 \r
 242     public void setColour(String featureType, Color col)\r
 243     {\r
 244       featureColours.put(featureType, col);\r
 245     }\r
 246 \r
 247     public void setTransparency(float value)\r
 248     {\r
 249       transparency = value;\r
 250     }\r
 251 \r
 252     public float getTransparency()\r
 253     {\r
 254       return transparency;\r
 255     }\r
 256 \r
 257     public void setFeaturePriority(Object [][] data)\r
 258     {\r
 259       // The feature table will display high priority\r
 260       // features at the top, but theses are the ones\r
 261       // we need to render last, so invert the data\r
 262       featuresDisplayed.clear();\r
 263       for(int i=data.length-1; i>-1; i--)\r
 264       {\r
 265        String type = data[i][0].toString();\r
 266        setColour(type, (Color)data[i][1]);\r
 267        if( ((Boolean)data[i][2]).booleanValue() )\r
 268          featuresDisplayed.addElement(type);\r
 269       }\r
 270     }\r
 271 \r
 272     Hashtable featureColours = new Hashtable();\r
 273     void initColours()\r
 274     {\r
 275       featureColours.put("active site", new Color(255, 75, 0));\r
 276       featureColours.put("binding site", new Color(245, 85, 0));\r
 277       featureColours.put("calcium-binding region", new Color(235, 95, 0));\r
 278       featureColours.put("chain", new Color(225, 105, 0));\r
 279       featureColours.put("coiled-coil region", new Color(215, 115, 0));\r
 280       featureColours.put("compositionally biased region", new Color(205, 125, 0));\r
 281       featureColours.put("cross-link", new Color(195, 135, 0));\r
 282       featureColours.put("disulfide bond", new Color(230,230,0));\r
 283       featureColours.put("DNA-binding region", new Color(175, 155, 0));\r
 284       featureColours.put("domain", new Color(165, 165, 0));\r
 285       featureColours.put("glycosylation site", new Color(155, 175, 0));\r
 286       featureColours.put("helix", new Color(145, 185, 0));\r
 287       featureColours.put("initiator methionine", new Color(135, 195, 5));\r
 288       featureColours.put("lipid moiety-binding region", new Color(125, 205, 15));\r
 289       featureColours.put("metal ion-binding site", new Color(115, 215, 25));\r
 290       featureColours.put("modified residue", new Color(105, 225, 35));\r
 291       featureColours.put("mutagenesis site", new Color(95, 235, 45));\r
 292       featureColours.put("non-consecutive residues", new Color(85, 245, 55));\r
 293       featureColours.put("non-terminal residue", new Color(75, 255, 65));\r
 294       featureColours.put("nucleotide phosphate-binding region",new Color(65, 245, 75));\r
 295       featureColours.put("peptide", new Color(55, 235, 85));\r
 296       featureColours.put("propeptide", new Color(45, 225, 95));\r
 297       featureColours.put("region of interest", new Color(35, 215, 105));\r
 298       featureColours.put("repeat", new Color(25, 205, 115));\r
 299       featureColours.put("selenocysteine", new Color(15, 195, 125));\r
 300       featureColours.put("sequence conflict", new Color(5, 185, 135));\r
 301       featureColours.put("sequence variant", new Color(0, 175, 145));\r
 302       featureColours.put("short sequence motif", new Color(0, 165, 155));\r
 303       featureColours.put("signal peptide", new Color(0, 155, 165));\r
 304       featureColours.put("site", new Color(0, 145, 175));\r
 305       featureColours.put("splice variant", new Color(0, 135, 185));\r
 306       featureColours.put("strand", new Color(0, 125, 195));\r
 307       featureColours.put("topological domain", new Color(0, 115, 205));\r
 308       featureColours.put("transit peptide", new Color(0, 105, 215));\r
 309       featureColours.put("transmembrane region", new Color(0, 95, 225));\r
 310       featureColours.put("turn", new Color(0, 85, 235));\r
 311       featureColours.put("unsure residue", new Color(0, 75, 245));\r
 312       featureColours.put("zinc finger region", new Color(0, 65, 255));\r
 313     }\r
 314 \r
 315 }\r