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 setBackgroundColour(Color col)
  60   {
  61     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/set.html
  62     return new StructureCommand("set bgColor " + ColorUtils.toTkCode(col));
  63   }
  64
  65   @Override
  66   public StructureCommandI colourResidues(String atomSpec, Color colour)
  67   {
  68     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/color.html
  69     String colourCode = getColourString(colour);
  70
  71     return new StructureCommand("color " + atomSpec + " " + colourCode);
  72   }
  73
  74   @Override
  75   public StructureCommandI focusView()
  76   {
  77     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/view.html
  78     return FOCUS_VIEW;
  79   }
  80
  81   /**
  82    * {@inheritDoc}
  83    *
  84    * @return
  85    */
  86   @Override
  87   public int getModelStartNo()
  88   {
  89     return 1;
  90   }
  91
  92   /**
  93    * Returns a viewer command to set the given residue attribute value on
  94    * residues specified by the AtomSpecModel, for example
  95    *
  96    * <pre>
  97    * setattr #0/A:3-9,14-20,39-43 res jv_strand 'strand' create true
  98    * </pre>
  99    *
 100    * @param attributeName
 101    * @param attributeValue
 102    * @param atomSpecModel
 103    * @return
 104    */
 105   @Override
 106   protected StructureCommandI setAttribute(String attributeName,
 107           String attributeValue, AtomSpecModel atomSpecModel)
 108   {
 109     StringBuilder sb = new StringBuilder(128);
 110     sb.append("setattr ").append(getAtomSpec(atomSpecModel, false));
 111     sb.append(" res ").append(attributeName).append(" '")
 112             .append(attributeValue).append("'");
 113     sb.append(" create true");
 114     return new StructureCommand(sb.toString());
 115   }
 116
 117   @Override
 118   public StructureCommandI openCommandFile(String path)
 119   {
 120     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/open.html
 121     return new StructureCommand("open " + path);
 122   }
 123
 124   @Override
 125   public StructureCommandI saveSession(String filepath)
 126   {
 127     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/save.html
 128     // note ChimeraX will append ".cxs" to the filepath!
 129     return new StructureCommand("save " + filepath + " format session");
 130   }
 131
 132   /**
 133    * Returns the range(s) formatted as a ChimeraX atomspec, for example
 134    * <p>
 135    * #1/A:2-20,30-40/B:10-20|#2/A:12-30
 136    *
 137    * @return
 138    */
 139   @Override
 140   public String getAtomSpec(AtomSpecModel atomSpec, boolean alphaOnly)
 141   {
 142     StringBuilder sb = new StringBuilder(128);
 143     boolean firstModel = true;
 144     for (String model : atomSpec.getModels())
 145     {
 146       if (!firstModel)
 147       {
 148         sb.append("|");
 149       }
 150       firstModel = false;
 151       appendModel(sb, model, atomSpec);
 152       if (alphaOnly)
 153       {
 154         // TODO @P if RNA - add nucleotide flag to AtomSpecModel?
 155         sb.append("@CA");
 156       }
 157       // todo: is there ChimeraX syntax to exclude altlocs?
 158     }
 159     return sb.toString();
 160   }
 161
 162   /**
 163    * A helper method to append an atomSpec string for atoms in the given model
 164    *
 165    * @param sb
 166    * @param model
 167    * @param atomSpec
 168    */
 169   protected void appendModel(StringBuilder sb, String model,
 170           AtomSpecModel atomSpec)
 171   {
 172     sb.append("#").append(model);
 173
 174     for (String chain : atomSpec.getChains(model))
 175     {
 176       boolean firstPositionForChain = true;
 177       sb.append("/").append(chain.trim()).append(":");
 178       List<int[]> rangeList = atomSpec.getRanges(model, chain);
 179       boolean first = true;
 180       for (int[] range : rangeList)
 181       {
 182         if (!first)
 183         {
 184           sb.append(",");
 185         }
 186         first = false;
 187         appendRange(sb, range[0], range[1], chain, firstPositionForChain,
 188                 true);
 189       }
 190     }
 191   }
 192
 193   @Override
 194   public List<StructureCommandI> showBackbone()
 195   {
 196     return Arrays.asList(SHOW_BACKBONE);
 197   }
 198
 199   @Override
 200   public List<StructureCommandI> superposeStructures(AtomSpecModel ref,
 201           AtomSpecModel spec)
 202   {
 203     /*
 204      * Form ChimeraX match command to match spec to ref
 205      *
 206      * match #1/A:2-94 toAtoms #2/A:1-93
 207      *
 208      * @see https://www.cgl.ucsf.edu/chimerax/docs/user/commands/align.html
 209      */
 210     StringBuilder cmd = new StringBuilder();
 211     String atomSpec = getAtomSpec(spec, true);
 212     String refSpec = getAtomSpec(ref, true);
 213     cmd.append("align ").append(atomSpec).append(" toAtoms ")
 214             .append(refSpec);
 215
 216     /*
 217      * show superposed residues as ribbon, others as chain
 218      */
 219     cmd.append("; ribbon ");
 220     cmd.append(getAtomSpec(spec, false)).append("|");
 221     cmd.append(getAtomSpec(ref, false)).append("; view");
 222
 223     return Arrays.asList(new StructureCommand(cmd.toString()));
 224   }
 225
 226   @Override
 227   public StructureCommandI openSession(String filepath)
 228   {
 229     // https://www.cgl.ucsf.edu/chimerax/docs/user/commands/open.html#composite
 230     return new StructureCommand("open " + filepath + " format session");
 231   }
 232 }