src/jalview/appletgui/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.appletgui;\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 /**\r
  28  * DOCUMENT ME!\r
  29  *\r
  30  * @author $author$\r
  31  * @version $Revision$\r
  32  */\r
  33 public class FeatureRenderer\r
  34 {\r
  35     AlignViewport av;\r
  36     SequenceGroup currentSequenceGroup = null;\r
  37     SequenceGroup[] allGroups = null;\r
  38     Graphics graphics;\r
  39     float transparency = .4f;\r
  40 \r
  41     // The following vector holds the features which are\r
  42     // to be added, in the correct order or rendering\r
  43     Vector featuresDisplayed;\r
  44 \r
  45     Color currentColour = null;\r
  46 \r
  47     /**\r
  48      * Creates a new FeatureRenderer object.\r
  49      *\r
  50      * @param av DOCUMENT ME!\r
  51      */\r
  52     public FeatureRenderer(AlignViewport av)\r
  53     {\r
  54         this.av = av;\r
  55         initColours();\r
  56         String version = System.getProperty("java.version");\r
  57         if (version.indexOf("1.1") == 0)\r
  58           highlightTransparent = false;\r
  59 \r
  60     }\r
  61 \r
  62     boolean highlightTransparent = true;\r
  63     /**\r
  64      * DOCUMENT ME!\r
  65      *\r
  66      * @param g DOCUMENT ME!\r
  67      * @param seq DOCUMENT ME!\r
  68      * @param sg DOCUMENT ME!\r
  69      * @param start DOCUMENT ME!\r
  70      * @param end DOCUMENT ME!\r
  71      * @param x1 DOCUMENT ME!\r
  72      * @param y1 DOCUMENT ME!\r
  73      * @param width DOCUMENT ME!\r
  74      * @param height DOCUMENT ME!\r
  75      */\r
  76     public void drawSequence(Graphics g, SequenceI seq,\r
  77         int start, int end, int x1, int y1, int width, int height)\r
  78     {\r
  79 \r
  80         if(seq.getSequenceFeatures()==null)\r
  81           return;\r
  82 \r
  83         Enumeration e = null, e2;\r
  84         String type;\r
  85         if(featuresDisplayed!=null)\r
  86           e = featuresDisplayed.elements();\r
  87         else\r
  88          e = seq.getSequenceFeatures().elements();\r
  89 \r
  90        if(highlightTransparent)\r
  91         {\r
  92         //  MyGraphics.SetTransparency(g, transparency);\r
  93         }\r
  94 \r
  95 \r
  96         while (e.hasMoreElements())\r
  97         {\r
  98             SequenceFeature sf=null;\r
  99             if(featuresDisplayed!=null)\r
 100             {\r
 101               e2 = seq.getSequenceFeatures().elements();\r
 102               type = e.nextElement().toString();\r
 103               while(e2.hasMoreElements())\r
 104               {\r
 105                 sf = (SequenceFeature) e2.nextElement();\r
 106                 if(sf.getType().equals(type))\r
 107                   break;\r
 108                 else\r
 109                   sf = null;\r
 110               }\r
 111             }\r
 112             else\r
 113             {\r
 114               sf = (SequenceFeature) e.nextElement();\r
 115               type = sf.getType();\r
 116             }\r
 117 \r
 118             if(sf==null)\r
 119               continue;\r
 120 \r
 121 \r
 122             if (sf.getBegin() > seq.getEnd())\r
 123             {\r
 124                 continue;\r
 125             }\r
 126 \r
 127             int fstart = seq.findIndex(sf.getBegin()) - 1;\r
 128             int fend = seq.findIndex(sf.getEnd()) - 1;\r
 129 \r
 130             if (((fstart <= end) && (fend >= start)))\r
 131             {\r
 132                 if (fstart < start)\r
 133                 { // fix for if the feature we have starts before the sequence start,\r
 134                     fstart = start; // but the feature end is still valid!!\r
 135                 }\r
 136 \r
 137                 if (fend >= end)\r
 138                 {\r
 139                     fend = end;\r
 140                 }\r
 141 \r
 142                 if (fstart == fend)\r
 143                 {\r
 144                     currentColour = getColour(type);\r
 145                     g.setColor(currentColour);\r
 146                     g.fillRoundRect((fstart - start) * width, y1, width,\r
 147                         height, 4, 4);\r
 148                     g.setColor(Color.white);\r
 149 \r
 150                     char s = seq.getSequence().charAt(fstart);\r
 151                     FontMetrics fm = g.getFontMetrics();\r
 152                     int charOffset = (width - fm.charWidth(s)) / 2;\r
 153                     int pady = height / 5;\r
 154                     g.drawString(String.valueOf(s),\r
 155                         charOffset + x1 + (width * (fstart - start)),\r
 156                         (y1 + height) - pady);\r
 157                 }\r
 158                 else\r
 159                 {\r
 160                     for (int i = fstart; i <= fend; i++)\r
 161                     {\r
 162                         char s = seq.getSequence().charAt(i);\r
 163 \r
 164                         if (jalview.util.Comparison.isGap(s))\r
 165                         {\r
 166                             continue;\r
 167                         }\r
 168                         currentColour = getColour(type);\r
 169                         g.setColor(currentColour);\r
 170 \r
 171                         g.fillRect((i - start) * width, y1, width, height);\r
 172 \r
 173                         g.setColor(Color.white);\r
 174 \r
 175                         FontMetrics fm = g.getFontMetrics();\r
 176                         int charOffset = (width - fm.charWidth(s)) / 2;\r
 177                         int pady = height / 5;\r
 178                         g.drawString(String.valueOf(s),\r
 179                             charOffset + x1 + (width * (i - start)),\r
 180                             (y1 + height) - pady);\r
 181                     }\r
 182                 }\r
 183             }\r
 184           }\r
 185 \r
 186           if (highlightTransparent)\r
 187           {\r
 188         //    MyGraphics.SetTransparency(g, 1.0f);\r
 189           }\r
 190     }\r
 191 \r
 192 \r
 193     Image offscreen;\r
 194     Frame nullframe;\r
 195     public Color findFeatureColour(Color initialCol, SequenceI seq, int i)\r
 196     {\r
 197       currentColour = initialCol;\r
 198       if(offscreen == null)\r
 199       {\r
 200         nullframe = new Frame();\r
 201         nullframe.addNotify();\r
 202         offscreen = nullframe.createImage(1, 1);\r
 203       }\r
 204 \r
 205       drawSequence(offscreen.getGraphics(), seq, i, i, 0, 0, 1, 1);\r
 206       return currentColour;\r
 207     }\r
 208 \r
 209 \r
 210 \r
 211     public Color getColour(String featureType)\r
 212     {\r
 213       return (Color)featureColours.get(featureType);\r
 214     }\r
 215 \r
 216     public void setColour(String featureType, Color col)\r
 217     {\r
 218       featureColours.put(featureType, col);\r
 219     }\r
 220 \r
 221     public void setTransparency(float value)\r
 222     {\r
 223       transparency = value;\r
 224     }\r
 225 \r
 226     public float getTransparency()\r
 227     {\r
 228       return transparency;\r
 229     }\r
 230 \r
 231     public void setFeaturePriority(Object [][] data)\r
 232     {\r
 233       // The feature table will display high priority\r
 234       // features at the top, but theses are the ones\r
 235       // we need to render last, so invert the data\r
 236       featuresDisplayed = new Vector();\r
 237       for(int i=data.length-1; i>-1; i--)\r
 238       {\r
 239        String type = data[i][0].toString();\r
 240        setColour(type, (Color)data[i][1]);\r
 241        if( ((Boolean)data[i][2]).booleanValue() )\r
 242          featuresDisplayed.addElement(type);\r
 243       }\r
 244     }\r
 245 \r
 246     Hashtable featureColours = new Hashtable();\r
 247     void initColours()\r
 248     {\r
 249       featureColours.put("active site", new Color(255, 75, 0));\r
 250       featureColours.put("binding site", new Color(245, 85, 0));\r
 251       featureColours.put("calcium-binding region", new Color(235, 95, 0));\r
 252       featureColours.put("chain", new Color(225, 105, 0));\r
 253       featureColours.put("coiled-coil region", new Color(215, 115, 0));\r
 254       featureColours.put("compositionally biased region", new Color(205, 125, 0));\r
 255       featureColours.put("cross-link", new Color(195, 135, 0));\r
 256       featureColours.put("disulfide bond", new Color(185, 145, 0));\r
 257       featureColours.put("DNA-binding region", new Color(175, 155, 0));\r
 258       featureColours.put("domain", new Color(165, 165, 0));\r
 259       featureColours.put("glycosylation site", new Color(155, 175, 0));\r
 260       featureColours.put("helix", new Color(145, 185, 0));\r
 261       featureColours.put("initiator methionine", new Color(135, 195, 5));\r
 262       featureColours.put("lipid moiety-binding region", new Color(125, 205, 15));\r
 263       featureColours.put("metal ion-binding site", new Color(115, 215, 25));\r
 264       featureColours.put("modified residue", new Color(105, 225, 35));\r
 265       featureColours.put("mutagenesis site", new Color(95, 235, 45));\r
 266       featureColours.put("non-consecutive residues", new Color(85, 245, 55));\r
 267       featureColours.put("non-terminal residue", new Color(75, 255, 65));\r
 268       featureColours.put("nucleotide phosphate-binding region",\r
 269                          new Color(65, 245, 75));\r
 270       featureColours.put("peptide", new Color(55, 235, 85));\r
 271       featureColours.put("propeptide", new Color(45, 225, 95));\r
 272       featureColours.put("region of interest", new Color(35, 215, 105));\r
 273       featureColours.put("repeat", new Color(25, 205, 115));\r
 274       featureColours.put("selenocysteine", new Color(15, 195, 125));\r
 275       featureColours.put("sequence conflict", new Color(5, 185, 135));\r
 276       featureColours.put("sequence variant", new Color(0, 175, 145));\r
 277       featureColours.put("short sequence motif", new Color(0, 165, 155));\r
 278       featureColours.put("signal peptide", new Color(0, 155, 165));\r
 279       featureColours.put("site", new Color(0, 145, 175));\r
 280       featureColours.put("splice variant", new Color(0, 135, 185));\r
 281       featureColours.put("strand", new Color(0, 125, 195));\r
 282       featureColours.put("topological domain", new Color(0, 115, 205));\r
 283       featureColours.put("transit peptide", new Color(0, 105, 215));\r
 284       featureColours.put("transmembrane region", new Color(0, 95, 225));\r
 285       featureColours.put("turn", new Color(0, 85, 235));\r
 286       featureColours.put("unsure residue", new Color(0, 75, 245));\r
 287       featureColours.put("zinc finger region", new Color(0, 65, 255));\r
 288     }\r
 289 \r
 290 }\r
 291 \r
 292 \r
 293 \r