src/jalview/ext/rbvi/chimera/ChimeraXCommands.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ext.rbvi.chimera;
  22
  23 import java.awt.Color;
  24 import java.util.Arrays;
  25 import java.util.List;
  26
  27 import jalview.structure.AtomSpecModel;
  28 import jalview.structure.StructureCommand;
  29 import jalview.structure.StructureCommandI;
  30 import jalview.util.ColorUtils;
  31
  32 /**
  33  * Routines for generating ChimeraX commands for Jalview/ChimeraX binding
  34  */
  35 public class ChimeraXCommands extends ChimeraCommands
  36 {
  37   private static final StructureCommand SHOW_BACKBONE = new StructureCommand(
  38           "~display all;~ribbon;show @CA|P atoms");
  39
  40   private static final StructureCommand FOCUS_VIEW = new StructureCommand(
  41           "view");
  42
  43   private static final StructureCommandI COLOUR_BY_CHARGE = new StructureCommand(
  44           "color white;color :ASP,GLU red;color :LYS,ARG blue;color :CYS yellow");
  45
  46   @Override
  47   public List<StructureCommandI> colourByCharge()
  48   {
  49     return Arrays.asList(COLOUR_BY_CHARGE);
  50   }
  51
  52   @Override
  53   public String getResidueSpec(String residue)
  54   {
  55     return ":" + residue;
  56   }
  57
  58   @Override
  59   public StructureCommandI colourResidues(String atomSpec, Color colour)
  60   {
  61     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/color.html
  62     String colourCode = getColourString(colour);
  63
  64     return new StructureCommand("color " + atomSpec + " " + colourCode);
  65   }
  66
  67   @Override
  68   public StructureCommandI focusView()
  69   {
  70     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/view.html
  71     return FOCUS_VIEW;
  72   }
  73
  74   /**
  75    * {@inheritDoc}
  76    *
  77    * @return
  78    */
  79   @Override
  80   public int getModelStartNo()
  81   {
  82     return 1;
  83   }
  84
  85   /**
  86    * Returns a viewer command to set the given residue attribute value on
  87    * residues specified by the AtomSpecModel, for example
  88    *
  89    * <pre>
  90    * setattr #0/A:3-9,14-20,39-43 res jv_strand 'strand' create true
  91    * </pre>
  92    *
  93    * @param attributeName
  94    * @param attributeValue
  95    * @param atomSpecModel
  96    * @return
  97    */
  98   @Override
  99   protected StructureCommandI setAttribute(String attributeName,
 100           String attributeValue, AtomSpecModel atomSpecModel)
 101   {
 102     StringBuilder sb = new StringBuilder(128);
 103     sb.append("setattr ").append(getAtomSpec(atomSpecModel, false));
 104     sb.append(" res ").append(attributeName).append(" '")
 105             .append(attributeValue).append("'");
 106     sb.append(" create true");
 107     return new StructureCommand(sb.toString());
 108   }
 109
 110   @Override
 111   public StructureCommandI openCommandFile(String path)
 112   {
 113     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/open.html
 114     return new StructureCommand("open " + path);
 115   }
 116
 117   @Override
 118   public StructureCommandI saveSession(String filepath)
 119   {
 120     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/save.html
 121     // note ChimeraX will append ".cxs" to the filepath!
 122     return new StructureCommand("save " + filepath + " format session");
 123   }
 124
 125   /**
 126    * Returns the range(s) formatted as a ChimeraX atomspec, for example
 127    * <p>
 128    * #1/A:2-20,30-40/B:10-20|#2/A:12-30
 129    *
 130    * @return
 131    */
 132   @Override
 133   public String getAtomSpec(AtomSpecModel atomSpec, boolean alphaOnly)
 134   {
 135     StringBuilder sb = new StringBuilder(128);
 136     boolean firstModel = true;
 137     for (String model : atomSpec.getModels())
 138     {
 139       if (!firstModel)
 140       {
 141         sb.append("|");
 142       }
 143       firstModel = false;
 144       appendModel(sb, model, atomSpec);
 145       if (alphaOnly)
 146       {
 147         // TODO @P if RNA - add nucleotide flag to AtomSpecModel?
 148         sb.append("@CA");
 149       }
 150       // todo: is there ChimeraX syntax to exclude altlocs?
 151     }
 152     return sb.toString();
 153   }
 154
 155   /**
 156    * A helper method to append an atomSpec string for atoms in the given model
 157    *
 158    * @param sb
 159    * @param model
 160    * @param atomSpec
 161    */
 162   protected void appendModel(StringBuilder sb, String model,
 163           AtomSpecModel atomSpec)
 164   {
 165     sb.append("#").append(model);
 166
 167     for (String chain : atomSpec.getChains(model))
 168     {
 169       boolean firstPositionForChain = true;
 170       sb.append("/").append(chain.trim()).append(":");
 171       List<int[]> rangeList = atomSpec.getRanges(model, chain);
 172       boolean first = true;
 173       for (int[] range : rangeList)
 174       {
 175         if (!first)
 176         {
 177           sb.append(",");
 178         }
 179         first = false;
 180         appendRange(sb, range[0], range[1], chain, firstPositionForChain,
 181                 true);
 182       }
 183     }
 184   }
 185
 186   @Override
 187   public List<StructureCommandI> showBackbone()
 188   {
 189     return Arrays.asList(SHOW_BACKBONE);
 190   }
 191
 192   @Override
 193   public List<StructureCommandI> superposeStructures(AtomSpecModel ref,
 194           AtomSpecModel spec)
 195   {
 196     /*
 197      * Form ChimeraX match command to match spec to ref
 198      *
 199      * match #1/A:2-94 toAtoms #2/A:1-93
 200      *
 201      * @see https://www.cgl.ucsf.edu/chimerax/docs/user/commands/align.html
 202      */
 203     StringBuilder cmd = new StringBuilder();
 204     String atomSpec = getAtomSpec(spec, true);
 205     String refSpec = getAtomSpec(ref, true);
 206     cmd.append("align ").append(atomSpec).append(" toAtoms ")
 207             .append(refSpec);
 208
 209     /*
 210      * show superposed residues as ribbon, others as chain
 211      */
 212     cmd.append("; ribbon ");
 213     cmd.append(getAtomSpec(spec, false)).append("|");
 214     cmd.append(getAtomSpec(ref, false)).append("; view");
 215
 216     return Arrays.asList(new StructureCommand(cmd.toString()));
 217   }
 218
 219   @Override
 220   public StructureCommandI openSession(String filepath)
 221   {
 222     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/open.html#composite
 223     // this version of the command has no dependency on file extension
 224     return new StructureCommand("open " + filepath + " format session");
 225   }
 226
 227   @Override
 228   public StructureCommandI closeViewer()
 229   {
 230     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/exit.html
 231     return new StructureCommand("exit");
 232   }
 233 }