JAL-2422 proof of concept adaptations for ChimeraX commands
[jalview.git] / src / jalview / ext / rbvi / chimera / JalviewChimeraBinding.java
index 01deea8..6e02efe 100644 (file)
@@ -51,6 +51,7 @@ import java.util.ArrayList;
 import java.util.BitSet;
 import java.util.Collections;
 import java.util.Hashtable;
+import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -349,7 +350,9 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
   public void colourByCharge()
   {
     colourBySequence = false;
-    String command = "color white;color red ::ASP;color red ::GLU;color blue ::LYS;color blue ::ARG;color yellow ::CYS";
+    String command = viewer.isChimeraX()
+            ? "color white;color :ASP,GLU red;color :LYS,ARG blue;color :CYS yellow"
+            : "color white;color red ::ASP;color red ::GLU;color blue ::LYS;color blue ::ARG;color yellow ::CYS";
     sendAsynchronousCommand(command, COLOURING_CHIMERA);
   }
 
@@ -370,6 +373,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
 
     refreshPdbEntries();
     StringBuilder selectioncom = new StringBuilder(256);
+    boolean chimeraX = viewer.isChimeraX();
     for (int a = 0; a < _alignment.length; a++)
     {
       int refStructure = _refStructure[a];
@@ -430,10 +434,16 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
       String[] selcom = new String[files.length];
       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
       {
+        final int modelNo = pdbfnum + (chimeraX ? 1 : 0);
+        // todo correct resolution to model number
         String chainCd = "." + structures[pdbfnum].chain;
         int lpos = -1;
         boolean run = false;
         StringBuilder molsel = new StringBuilder();
+        if (chimeraX)
+        {
+          molsel.append("/" + structures[pdbfnum].chain + ":");
+        }
 
         int nextColumnMatch = matched.nextSetBit(0);
         while (nextColumnMatch != -1)
@@ -447,7 +457,10 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
             if (lpos != -1)
             {
               molsel.append(String.valueOf(lpos));
-              molsel.append(chainCd);
+              if (!chimeraX)
+              {
+                molsel.append(chainCd);
+              }
               molsel.append(",");
             }
             run = false;
@@ -477,18 +490,24 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
         if (lpos != -1)
         {
           molsel.append(String.valueOf(lpos));
-          molsel.append(chainCd);
+          if (!chimeraX)
+          {
+            molsel.append(chainCd);
+          }
         }
         if (molsel.length() > 1)
         {
           selcom[pdbfnum] = molsel.toString();
-          selectioncom.append("#").append(String.valueOf(pdbfnum))
-                  .append(":");
+          selectioncom.append("#").append(String.valueOf(modelNo));
+          if (!chimeraX)
+          {
+            selectioncom.append(":");
+          }
           selectioncom.append(selcom[pdbfnum]);
-          selectioncom.append(" ");
+          // selectioncom.append(" ");
           if (pdbfnum < files.length - 1)
           {
-            selectioncom.append("| ");
+            selectioncom.append("|");
           }
         }
         else
@@ -500,6 +519,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
       StringBuilder command = new StringBuilder(256);
       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
       {
+        final int modelNo = pdbfnum + (chimeraX ? 1 : 0);
         if (pdbfnum == refStructure || selcom[pdbfnum] == null
                 || selcom[refStructure] == null)
         {
@@ -519,17 +539,33 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
          * @see
          * https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html
          */
-        command.append("match ").append(getModelSpec(pdbfnum)).append(":");
+        command.append(chimeraX ? "align " : "match ");
+        command.append(getModelSpec(modelNo));
+        if (!chimeraX)
+        {
+          command.append(":");
+        }
         command.append(selcom[pdbfnum]);
         command.append("@").append(
                 structures[pdbfnum].isRna ? PHOSPHORUS : ALPHACARBON);
-        // JAL-1757 exclude alternate CA locations
-        command.append(NO_ALTLOCS);
-        command.append(" ").append(getModelSpec(refStructure)).append(":");
+        // JAL-1757 exclude alternate CA locations - ChimeraX syntax tbd
+        if (!chimeraX)
+        {
+          command.append(NO_ALTLOCS);
+        }
+        command.append(chimeraX ? " toAtoms " : " ")
+                .append(getModelSpec(refStructure + (chimeraX ? 1 : 0)));
+        if (!chimeraX)
+        {
+          command.append(":");
+        }
         command.append(selcom[refStructure]);
         command.append("@").append(
                 structures[refStructure].isRna ? PHOSPHORUS : ALPHACARBON);
-        command.append(NO_ALTLOCS);
+        if (!chimeraX)
+        {
+          command.append(NO_ALTLOCS);
+        }
       }
       if (selectioncom.length() > 0)
       {
@@ -539,9 +575,21 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
           System.out.println(
                   "Superimpose command(s):\n" + command.toString());
         }
-        allComs.append("~display all; chain @CA|P; ribbon ")
-                .append(selectioncom.toString())
-                .append(";" + command.toString());
+        // allComs.append("~display all; ");
+        // if (chimeraX)
+        // {
+        // allComs.append("show ").append(selectioncom.toString())
+        // .append(" pbonds");
+        // }
+        // else
+        // {
+        // allComs.append("chain @CA|P; ribbon ");
+        // allComs.append(selectioncom.toString());
+        // }
+        if (allComs.length() > 0) {
+          allComs.append(";");
+        }
+        allComs.append(command.toString());
       }
     }
 
@@ -557,8 +605,19 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
       {
         System.out.println("Select regions:\n" + selectioncom.toString());
       }
-      allComs.append("; ~display all; chain @CA|P; ribbon ")
-              .append(selectioncom.toString()).append("; focus");
+      allComs.append(";~display all; ");
+      if (chimeraX)
+      {
+        allComs.append("show @CA|P pbonds; show ")
+                .append(selectioncom.toString()).append(" ribbons; view");
+      }
+      else
+      {
+        allComs.append("chain @CA|P; ribbon ; focus");
+        allComs.append(selectioncom.toString());
+      }
+      // allComs.append("; ~display all; chain @CA|P; ribbon ")
+      // .append(selectioncom.toString()).append("; focus");
       List<String> chimeraReplies = sendChimeraCommand(allComs.toString(),
               true);
       for (String reply : chimeraReplies)
@@ -589,7 +648,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
   {
     if (pdbfnum < 0 || pdbfnum >= getPdbCount())
     {
-      return "";
+      return "#" + pdbfnum; // temp hack for ChimeraX
     }
 
     /*
@@ -885,12 +944,13 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
   protected List<AtomSpec> convertStructureResiduesToAlignment(
           List<String> structureSelection)
   {
+    boolean chimeraX = viewer.isChimeraX();
     List<AtomSpec> atomSpecs = new ArrayList<>();
     for (String atomSpec : structureSelection)
     {
       try
       {
-        AtomSpec spec = AtomSpec.fromChimeraAtomspec(atomSpec);
+        AtomSpec spec = AtomSpec.fromChimeraAtomspec(atomSpec, chimeraX);
         String pdbfilename = getPdbFileForModel(spec.getModelNumber());
         spec.setPdbFile(pdbfilename);
         atomSpecs.add(spec);
@@ -952,22 +1012,35 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
       return;
     }
 
-    // Chimera expects RBG values in the range 0-1
-    final double normalise = 255D;
     viewerCommandHistory(false);
     StringBuilder command = new StringBuilder(128);
 
     List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
             false);
+
+    /*
+     * concatenate colour commands, one per residue symbol
+     * Chimera format:  color 0.000000,0.372549,0.627451 ::VAL
+     * ChimeraX format: color :VAL rgb(73,73,182)
+     */
+    boolean chimeraX = viewer.isChimeraX();
     for (String resName : residueSet)
     {
       char res = resName.length() == 3
               ? ResidueProperties.getSingleCharacterCode(resName)
               : resName.charAt(0);
       Color col = cs.findColour(res, 0, null, null, 0f);
-      command.append("color " + col.getRed() / normalise + ","
-              + col.getGreen() / normalise + "," + col.getBlue() / normalise
-              + " ::" + resName + ";");
+      command.append("color ");
+      String colorSpec = getRgbDescriptor(col, chimeraX);
+      if (chimeraX)
+      {
+        command.append(":").append(resName).append(" ").append(colorSpec);
+      }
+      else
+      {
+        command.append(colorSpec).append(" ::").append(resName);
+      }
+      command.append(";");
     }
 
     sendAsynchronousCommand(command.toString(), COLOURING_CHIMERA);
@@ -1022,15 +1095,40 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
   public void setBackgroundColour(Color col)
   {
     viewerCommandHistory(false);
-    double normalise = 255D;
-    final String command = "background solid " + col.getRed() / normalise
-            + "," + col.getGreen() / normalise + ","
-            + col.getBlue() / normalise + ";";
+    String command = "set bgColor "
+            + getRgbDescriptor(col, viewer.isChimeraX());
     viewer.sendChimeraCommand(command, false);
     viewerCommandHistory(true);
   }
 
   /**
+   * Answers the Chimera/X format for RGB values of the given colour.
+   * 
+   * <pre>
+   * Chimera: r,g,b with values scaled [0=1]
+   * ChimeraX: rgb(r,g,b) with values scaled 0-255
+   * </pre>
+   * 
+   * @param col
+   * @param chimeraX
+   * @return
+   */
+  private static String getRgbDescriptor(Color col, boolean chimeraX)
+  {
+    if (chimeraX)
+    {
+      return String.format("rgb(%d,%d,%d)", col.getRed(), col.getGreen(),
+              col.getBlue());
+    }
+    else
+    {
+      double scale = 255D;
+      return String.format("%f,%f,%f", col.getRed() / scale,
+              col.getGreen() / scale, col.getBlue() / scale);
+    }
+  }
+
+  /**
    * Ask Chimera to save its session to the given file. Returns true if
    * successful, else false.
    * 
@@ -1087,7 +1185,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
    */
   public void focusView()
   {
-    sendChimeraCommand("focus", false);
+    sendChimeraCommand(viewer.isChimeraX() ? "view" : "focus", false);
   }
 
   /**
@@ -1235,6 +1333,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
   {
     boolean featureAdded = false;
     String featureGroup = getViewerFeatureGroup();
+    boolean chimeraX = viewer.isChimeraX();
 
     for (String residue : residues)
     {
@@ -1258,7 +1357,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
 
       try
       {
-        spec = AtomSpec.fromChimeraAtomspec(atomSpec);
+        spec = AtomSpec.fromChimeraAtomspec(atomSpec, chimeraX);
       } catch (IllegalArgumentException e)
       {
         System.err.println("Problem parsing atomspec " + atomSpec);
@@ -1338,4 +1437,27 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel
     }
     return -1;
   }
+
+  /**
+   * Answers a (possibly empty) list of attribute names in Chimera[X], excluding
+   * any which were added from Jalview
+   * 
+   * @return
+   */
+  public List<String> getChimeraAttributes()
+  {
+    List<String> atts = viewer.getAttrList();
+    Iterator<String> it = atts.iterator();
+    while (it.hasNext())
+    {
+      if (it.next().startsWith(ChimeraCommands.NAMESPACE_PREFIX))
+      {
+        /*
+         * attribute added from Jalview - exclude it
+         */
+        it.remove();
+      }
+    }
+    return atts;
+  }
 }