header updated
[jalview.git] / src / jalview / gui / FeatureRenderer.java
index 3f332b5..afe29a0 100755 (executable)
@@ -1,6 +1,6 @@
 /*\r
  * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
  *\r
  * This program is free software; you can redistribute it and/or\r
  * modify it under the terms of the GNU General Public License\r
@@ -40,11 +40,19 @@ public class FeatureRenderer
     float transparency = 1.0f;\r
     FontMetrics fm;\r
     int charOffset;\r
-    boolean drawText = true;\r
 \r
-    // The following vector holds the features which are\r
-    // to be added, in the correct order or rendering\r
-    Vector featuresDisplayed = null;\r
+    Hashtable featureColours = new Hashtable();\r
+\r
+\r
+    // A higher level for grouping features of a\r
+   // particular type\r
+    Hashtable featureGroups = null;\r
+\r
+    // This is actually an Integer held in the hashtable,\r
+    // Retrieved using the key feature type\r
+    Object currentColour;\r
+\r
+    String [] renderOrder;\r
 \r
     /**\r
      * Creates a new FeatureRenderer object.\r
@@ -54,30 +62,80 @@ public class FeatureRenderer
     public FeatureRenderer(AlignViewport av)\r
     {\r
         this.av = av;\r
-        initColours();\r
+    }\r
+\r
+    public void transferSettings(FeatureRenderer fr)\r
+    {\r
+      renderOrder = fr.renderOrder;\r
+      featureGroups = fr.featureGroups;\r
+      featureColours = fr.featureColours;\r
+      transparency =  fr.transparency;\r
+    }\r
+\r
+    BufferedImage offscreenImage;\r
+    boolean offscreenRender = false;\r
+    public Color findFeatureColour(Color initialCol, SequenceI seq, int res)\r
+    {\r
+      return new Color( findFeatureColour (initialCol.getRGB(),\r
+                        seq, res ));\r
     }\r
 \r
     /**\r
-     * This is used by the Molecule Viewer to get the accurate colour\r
-     * of the rendered sequence\r
+     * This is used by the Molecule Viewer and Overview to\r
+     * get the accurate colourof the rendered sequence\r
      */\r
-    BufferedImage bi;\r
-    public Color findFeatureColour(Color initialCol, SequenceI seq, int i)\r
+    public int findFeatureColour(int initialCol, SequenceI seq, int column)\r
     {\r
       if(!av.showSequenceFeatures)\r
         return initialCol;\r
 \r
-      if (bi == null)\r
-        bi = new BufferedImage(1, 1, BufferedImage.TYPE_INT_RGB);\r
+      if(seq!=lastSeq)\r
+      {\r
+        lastSeq = seq;\r
+        sequenceFeatures = lastSeq.getDatasetSequence().getSequenceFeatures();\r
+        if(sequenceFeatures==null)\r
+          return initialCol;\r
 \r
-      bi.setRGB(0,0, initialCol.getRGB());\r
+        sfSize = sequenceFeatures.length;\r
+      }\r
 \r
-      drawText = false;\r
+      if(jalview.util.Comparison.isGap(lastSeq.getCharAt(column)))\r
+        return Color.white.getRGB();\r
+\r
+\r
+      //Only bother making an offscreen image if transparency is applied\r
+      if(transparency!=1.0f && offscreenImage==null)\r
+      {\r
+        offscreenImage = new BufferedImage(1,1,BufferedImage.TYPE_INT_ARGB);\r
+      }\r
+\r
+      currentColour = null;\r
+\r
+      offscreenRender = true;\r
+\r
+      if(offscreenImage!=null)\r
+      {\r
+        offscreenImage.setRGB(0,0,initialCol);\r
+        drawSequence(offscreenImage.getGraphics(),\r
+                     lastSeq,\r
+                     column,column,0);\r
+\r
+        return offscreenImage.getRGB(0,0);\r
+      }\r
+      else\r
+      {\r
+        drawSequence(null,\r
+                    lastSeq,\r
+                    lastSeq.findPosition(column),\r
+                    -1, -1);\r
+\r
+        if (currentColour == null)\r
+          return initialCol;\r
+        else\r
+          return  ((Integer)currentColour).intValue();\r
+      }\r
 \r
-      drawSequence(bi.getGraphics(), seq, i, i, 0, 0, 1, 1);\r
-      drawText = true;\r
 \r
-      return new Color(bi.getRGB(0, 0));\r
     }\r
 \r
 \r
@@ -94,18 +152,44 @@ public class FeatureRenderer
      * @param width DOCUMENT ME!\r
      * @param height DOCUMENT ME!\r
      */\r
+   // String type;\r
+   // SequenceFeature sf;\r
+    SequenceI lastSeq;\r
+    SequenceFeature [] sequenceFeatures;\r
+    int sfSize, sfindex, spos, epos;\r
+\r
     public void drawSequence(Graphics g, SequenceI seq,\r
-                             int start, int end, int x1, int y1, int width, int height)\r
+                             int start, int end, int y1)\r
     {\r
-\r
-//System.out.println(start+" "+end+" "+x1+" "+y1);\r
-      if (seq.getDatasetSequence().getSequenceFeatures() == null\r
-          || seq.getDatasetSequence().getSequenceFeatures().size()==0)\r
+      if ( seq.getDatasetSequence().getSequenceFeatures() == null\r
+          || seq.getDatasetSequence().getSequenceFeatures().length==0)\r
         return;\r
 \r
-      fm = g.getFontMetrics();\r
+      if(g!=null)\r
+        fm = g.getFontMetrics();\r
 \r
-      if (transparency != 1)\r
+\r
+      if (av.featuresDisplayed == null\r
+          || renderOrder==null\r
+          || newFeatureAdded)\r
+       {\r
+         findAllFeatures();\r
+         if(av.featuresDisplayed.size()<1)\r
+           return;\r
+\r
+         sequenceFeatures = seq.getDatasetSequence().getSequenceFeatures();\r
+         sfSize = sequenceFeatures.length;\r
+       }\r
+\r
+       if(lastSeq==null || seq!=lastSeq)\r
+      {\r
+        lastSeq = seq;\r
+        sequenceFeatures = seq.getDatasetSequence().getSequenceFeatures();\r
+        sfSize = sequenceFeatures.length;\r
+      }\r
+\r
+\r
+      if (transparency != 1 && g!=null)\r
       {\r
         Graphics2D g2 = (Graphics2D) g;\r
         g2.setComposite(\r
@@ -113,53 +197,86 @@ public class FeatureRenderer
                 AlphaComposite.SRC_OVER, transparency));\r
       }\r
 \r
-      String type;\r
-      SequenceFeature sf;\r
-      if (featuresDisplayed == null)\r
-        findAllFeatures();\r
+      if(!offscreenRender)\r
+      {\r
+        spos = lastSeq.findPosition(start);\r
+        epos = lastSeq.findPosition(end);\r
+      }\r
 \r
-      Enumeration e = featuresDisplayed.elements(), e2;\r
 \r
-      // Loop through each visible feature\r
-      while (e.hasMoreElements())\r
-      {\r
+      String type;\r
+      for(int renderIndex=0; renderIndex<renderOrder.length; renderIndex++)\r
+       {\r
+        type =  renderOrder[renderIndex];\r
+\r
+        if(!av.featuresDisplayed.containsKey(type))\r
+          continue;\r
 \r
-        type = e.nextElement().toString();\r
-        e2 = seq.getDatasetSequence().getSequenceFeatures().elements();\r
         // loop through all features in sequence to find\r
         // current feature to render\r
-          while (e2.hasMoreElements())\r
+        for (sfindex = 0; sfindex < sfSize; sfindex++)\r
         {\r
+          if(sequenceFeatures.length<=sfindex)\r
+          {\r
+            continue;\r
+          }\r
+          if (!sequenceFeatures[sfindex].type.equals(type))\r
+            continue;\r
 \r
-          sf = (SequenceFeature) e2.nextElement();\r
-          if (!type.equals(sf.getType()))\r
+          if (featureGroups != null\r
+              && sequenceFeatures[sfindex].featureGroup != null\r
+              &&\r
+              featureGroups.containsKey(sequenceFeatures[sfindex].featureGroup)\r
+              &&\r
+              ! ( (Boolean) featureGroups.get(sequenceFeatures[sfindex].featureGroup)).\r
+              booleanValue())\r
+          {\r
             continue;\r
+          }\r
 \r
-          if (sf.getBegin() > seq.getEnd())\r
+          if (!offscreenRender && (sequenceFeatures[sfindex].getBegin() > epos\r
+                            || sequenceFeatures[sfindex].getEnd() < spos))\r
             continue;\r
 \r
-          if (type.equals("disulfide bond"))\r
+          if (offscreenRender && offscreenImage==null)\r
+          {\r
+            if (sequenceFeatures[sfindex].begin <= start &&\r
+                sequenceFeatures[sfindex].end  >= start)\r
+            {\r
+              currentColour = av.featuresDisplayed.get(sequenceFeatures[sfindex].\r
+                 type);\r
+            }\r
+          }\r
+          else if (sequenceFeatures[sfindex].type.equals("disulfide bond"))\r
           {\r
 \r
             renderFeature(g, seq,\r
-                          seq.findIndex(sf.getBegin()) - 1,\r
-                          seq.findIndex(sf.getBegin()) - 1,\r
-                          type, start, end, x1, y1, width, height);\r
+                          seq.findIndex(sequenceFeatures[sfindex].begin) - 1,\r
+                          seq.findIndex(sequenceFeatures[sfindex].begin) - 1,\r
+                          new Color( ( (Integer) av.featuresDisplayed.get(\r
+                sequenceFeatures[sfindex].type)).intValue()),\r
+                          start, end, y1);\r
             renderFeature(g, seq,\r
-                          seq.findIndex(sf.getEnd()) - 1,\r
-                          seq.findIndex(sf.getEnd()) - 1,\r
-                          type, start, end, x1, y1, width, height);\r
+                          seq.findIndex(sequenceFeatures[sfindex].end) - 1,\r
+                          seq.findIndex(sequenceFeatures[sfindex].end) - 1,\r
+                          new Color( ( (Integer) av.featuresDisplayed.get(\r
+                sequenceFeatures[sfindex].type)).intValue()),\r
+                          start, end, y1);\r
 \r
           }\r
           else\r
             renderFeature(g, seq,\r
-                          seq.findIndex(sf.getBegin()) - 1,\r
-                          seq.findIndex(sf.getEnd()) - 1,\r
-                          type, start, end, x1, y1, width, height);\r
+                          seq.findIndex(sequenceFeatures[sfindex].begin) - 1,\r
+                          seq.findIndex(sequenceFeatures[sfindex].end) - 1,\r
+                          getColour(sequenceFeatures[sfindex].type),\r
+                          start, end, y1);\r
+\r
+\r
         }\r
+\r
       }\r
 \r
-        if(transparency!=1.0f)\r
+        if(transparency!=1.0f && g!=null)\r
         {\r
           Graphics2D g2 = (Graphics2D) g;\r
           g2.setComposite(\r
@@ -169,74 +286,144 @@ public class FeatureRenderer
     }\r
 \r
 \r
+    char s;\r
+    int i;\r
     void renderFeature(Graphics g, SequenceI seq,\r
-                       int fstart, int fend, String type, int start, int end, int x1, int y1, int width, int height)\r
+                       int fstart, int fend, Color featureColour, int start, int end,  int y1)\r
     {\r
 \r
       if (((fstart <= end) && (fend >= start)))\r
       {\r
-          if (fstart < start)\r
-          { // fix for if the feature we have starts before the sequence start,\r
-              fstart = start; // but the feature end is still valid!!\r
-          }\r
+        if (fstart < start)\r
+        { // fix for if the feature we have starts before the sequence start,\r
+          fstart = start; // but the feature end is still valid!!\r
+        }\r
 \r
-          if (fend >= end)\r
-          {\r
-            fend = end;\r
-          }\r
-          for (int i = fstart; i <= fend; i++)\r
+        if (fend >= end)\r
+        {\r
+          fend = end;\r
+        }\r
+          int pady = (y1 + av.charHeight) - av.charHeight / 5;\r
+          for (i = fstart; i <= fend; i++)\r
           {\r
-            char s = seq.getSequence().charAt(i);\r
+            s = seq.getSequence().charAt(i);\r
 \r
             if (jalview.util.Comparison.isGap(s))\r
             {\r
               continue;\r
             }\r
 \r
-            g.setColor(getColour(type));\r
+            g.setColor(featureColour);\r
 \r
-            g.fillRect( (i - start) * width, y1, width, height);\r
+            g.fillRect( (i - start) * av.charWidth, y1, av.charWidth,av.charHeight);\r
+\r
+            if(offscreenRender || !av.validCharWidth)\r
+              continue;\r
+\r
+            g.setColor(Color.white);\r
+            charOffset = (av.charWidth - fm.charWidth(s)) / 2;\r
+            g.drawString(String.valueOf(s),\r
+                         charOffset + (av.charWidth * (i - start)),\r
+                         pady);\r
 \r
-            if(drawText)\r
-           {\r
-             g.setColor(Color.white);\r
-             charOffset = (width - fm.charWidth(s)) / 2;\r
-             g.drawString(String.valueOf(s),\r
-                          charOffset + x1 + (width * (i - start)),\r
-                          (y1 + height) - height / 5); //pady = height / 5;\r
-           }\r
           }\r
-        }\r
+      }\r
     }\r
 \r
-    void findAllFeatures()\r
+\r
+    boolean newFeatureAdded = false;\r
+\r
+    public void featuresAdded()\r
     {\r
-      Vector features = new Vector();\r
-      SequenceFeature sf;\r
-      featuresDisplayed = new Vector();\r
-      Enumeration e;\r
+      findAllFeatures();\r
+    }\r
+\r
+   boolean findingFeatures = false;\r
+   synchronized void findAllFeatures()\r
+   {\r
+      newFeatureAdded = false;\r
+\r
+      if(findingFeatures)\r
+      {\r
+        newFeatureAdded = true;\r
+        return;\r
+      }\r
+\r
+      findingFeatures = true;\r
+      jalview.schemes.UserColourScheme ucs = new\r
+          jalview.schemes.UserColourScheme();\r
+\r
+      if(av.featuresDisplayed==null)\r
+        av.featuresDisplayed = new Hashtable();\r
+\r
+      av.featuresDisplayed.clear();\r
+\r
+      Vector allfeatures = new Vector();\r
       for (int i = 0; i < av.alignment.getHeight(); i++)\r
       {\r
-        features = av.alignment.getSequenceAt(i).getDatasetSequence().\r
-            getSequenceFeatures();\r
+        SequenceFeature [] features\r
+            = av.alignment.getSequenceAt(i).getDatasetSequence().getSequenceFeatures();\r
+\r
         if (features == null)\r
           continue;\r
 \r
-        e = features.elements();\r
-        while (e.hasMoreElements())\r
+        int index = 0;\r
+        while (index < features.length)\r
         {\r
-          sf = (SequenceFeature) e.nextElement();\r
-          if (!featuresDisplayed.contains(sf.getType()))\r
+          if (!av.featuresDisplayed.containsKey(features[index].getType()))\r
           {\r
-            featuresDisplayed.addElement(sf.getType());\r
+            if(!(features[index].begin == 0 && features[index].end ==0))\r
+            {\r
+              // If beginning and end are 0, the feature is for the whole sequence\r
+              // and we don't want to render the feature in the normal way\r
+\r
+              if (getColour(features[index].getType()) == null)\r
+              {\r
+                 featureColours.put(features[index].getType(),\r
+                                   ucs.createColourFromName(features[index].\r
+                    getType()));\r
+              }\r
+\r
+              av.featuresDisplayed.put(features[index].getType(),\r
+                                       new Integer(getColour(features[index].\r
+                  getType()).getRGB()));\r
+              allfeatures.addElement(features[index].getType());\r
+            }\r
           }\r
+          index++;\r
         }\r
       }\r
+\r
+      renderOrder = new String[allfeatures.size()];\r
+      Enumeration en = allfeatures.elements();\r
+      int i = allfeatures.size()-1;\r
+      while(en.hasMoreElements())\r
+      {\r
+        renderOrder[i] = en.nextElement().toString();\r
+        i--;\r
+      }\r
+\r
+      findingFeatures = false;\r
     }\r
 \r
     public Color getColour(String featureType)\r
     {\r
-      return (Color)featureColours.get(featureType);\r
+      Color colour = (Color)featureColours.get(featureType);\r
+      return colour;\r
+    }\r
+\r
+\r
+    public void addNewFeature(String name, Color col, String group)\r
+    {\r
+\r
+      setColour(name, col);\r
+      if(av.featuresDisplayed==null)\r
+        av.featuresDisplayed = new Hashtable();\r
+\r
+      if(group == null)\r
+        group = "NOGROUP";\r
+\r
+      av.featuresDisplayed.put(name, new Integer(col.getRGB()));\r
     }\r
 \r
     public void setColour(String featureType, Color col)\r
@@ -259,57 +446,29 @@ public class FeatureRenderer
       // The feature table will display high priority\r
       // features at the top, but theses are the ones\r
       // we need to render last, so invert the data\r
-      featuresDisplayed.clear();\r
-      for(int i=data.length-1; i>-1; i--)\r
-      {\r
-       String type = data[i][0].toString();\r
-       setColour(type, (Color)data[i][1]);\r
-       if( ((Boolean)data[i][2]).booleanValue() )\r
-         featuresDisplayed.addElement(type);\r
-      }\r
-    }\r
+      if(av.featuresDisplayed!=null)\r
+        av.featuresDisplayed.clear();\r
+      else\r
+        av.featuresDisplayed = new Hashtable();\r
+\r
+      renderOrder = new String[data.length];\r
+\r
+      if (data.length > 0)\r
+        for (int i = 0; i < data.length; i++)\r
+        {\r
+          String type = data[i][0].toString();\r
+          setColour(type, (Color) data[i][1]);\r
+          if ( ( (Boolean) data[i][2]).booleanValue())\r
+          {\r
+            av.featuresDisplayed.put(type, new Integer(getColour(type).getRGB()));\r
+          }\r
+\r
+          renderOrder[data.length - i - 1] = type;\r
+        }\r
 \r
-    Hashtable featureColours = new Hashtable();\r
-    void initColours()\r
-    {\r
-      featureColours.put("active site", new Color(255, 75, 0));\r
-      featureColours.put("binding site", new Color(245, 85, 0));\r
-      featureColours.put("calcium-binding region", new Color(235, 95, 0));\r
-      featureColours.put("chain", new Color(225, 105, 0));\r
-      featureColours.put("coiled-coil region", new Color(215, 115, 0));\r
-      featureColours.put("compositionally biased region", new Color(205, 125, 0));\r
-      featureColours.put("cross-link", new Color(195, 135, 0));\r
-      featureColours.put("disulfide bond", new Color(230,230,0));\r
-      featureColours.put("DNA-binding region", new Color(175, 155, 0));\r
-      featureColours.put("domain", new Color(165, 165, 0));\r
-      featureColours.put("glycosylation site", new Color(155, 175, 0));\r
-      featureColours.put("helix", new Color(145, 185, 0));\r
-      featureColours.put("initiator methionine", new Color(135, 195, 5));\r
-      featureColours.put("lipid moiety-binding region", new Color(125, 205, 15));\r
-      featureColours.put("metal ion-binding site", new Color(115, 215, 25));\r
-      featureColours.put("modified residue", new Color(105, 225, 35));\r
-      featureColours.put("mutagenesis site", new Color(95, 235, 45));\r
-      featureColours.put("non-consecutive residues", new Color(85, 245, 55));\r
-      featureColours.put("non-terminal residue", new Color(75, 255, 65));\r
-      featureColours.put("nucleotide phosphate-binding region",new Color(65, 245, 75));\r
-      featureColours.put("peptide", new Color(55, 235, 85));\r
-      featureColours.put("propeptide", new Color(45, 225, 95));\r
-      featureColours.put("region of interest", new Color(35, 215, 105));\r
-      featureColours.put("repeat", new Color(25, 205, 115));\r
-      featureColours.put("selenocysteine", new Color(15, 195, 125));\r
-      featureColours.put("sequence conflict", new Color(5, 185, 135));\r
-      featureColours.put("sequence variant", new Color(0, 175, 145));\r
-      featureColours.put("short sequence motif", new Color(0, 165, 155));\r
-      featureColours.put("signal peptide", new Color(0, 155, 165));\r
-      featureColours.put("site", new Color(0, 145, 175));\r
-      featureColours.put("splice variant", new Color(0, 135, 185));\r
-      featureColours.put("strand", new Color(0, 125, 195));\r
-      featureColours.put("topological domain", new Color(0, 115, 205));\r
-      featureColours.put("transit peptide", new Color(0, 105, 215));\r
-      featureColours.put("transmembrane region", new Color(0, 95, 225));\r
-      featureColours.put("turn", new Color(0, 85, 235));\r
-      featureColours.put("unsure residue", new Color(0, 75, 245));\r
-      featureColours.put("zinc finger region", new Color(0, 65, 255));\r
     }\r
 \r
+\r
+\r
+\r
 }\r