src/jalview/ext/rbvi/chimera/JalviewChimeraBinding.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 jalview.api.AlignmentViewPanel;
  24 import jalview.api.FeatureRenderer;
  25 import jalview.api.SequenceRenderer;
  26 import jalview.bin.Cache;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.ColumnSelection;
  29 import jalview.datamodel.PDBEntry;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.httpserver.AbstractRequestHandler;
  32 import jalview.schemes.ColourSchemeI;
  33 import jalview.schemes.ResidueProperties;
  34 import jalview.structure.AtomSpec;
  35 import jalview.structure.StructureMappingcommandSet;
  36 import jalview.structure.StructureSelectionManager;
  37 import jalview.structures.models.AAStructureBindingModel;
  38 import jalview.util.MessageManager;
  39
  40 import java.awt.Color;
  41 import java.net.BindException;
  42 import java.util.ArrayList;
  43 import java.util.Hashtable;
  44 import java.util.LinkedHashMap;
  45 import java.util.List;
  46 import java.util.Map;
  47
  48 import ext.edu.ucsf.rbvi.strucviz2.ChimeraManager;
  49 import ext.edu.ucsf.rbvi.strucviz2.ChimeraModel;
  50 import ext.edu.ucsf.rbvi.strucviz2.StructureManager;
  51 import ext.edu.ucsf.rbvi.strucviz2.StructureManager.ModelType;
  52
  53 public abstract class JalviewChimeraBinding extends AAStructureBindingModel
  54 {
  55   // Chimera clause to exclude alternate locations in atom selection
  56   private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9";
  57
  58   private static final String COLOURING_CHIMERA = MessageManager
  59           .getString("status.colouring_chimera");
  60
  61   private static final boolean debug = false;
  62
  63   private static final String PHOSPHORUS = "P";
  64
  65   private static final String ALPHACARBON = "CA";
  66
  67   private List<String> chainNames = new ArrayList<String>();
  68
  69   private Hashtable<String, String> chainFile = new Hashtable<String, String>();
  70   /*
  71    * Object through which we talk to Chimera
  72    */
  73   private ChimeraManager viewer;
  74
  75   /*
  76    * Object which listens to Chimera notifications
  77    */
  78   private AbstractRequestHandler chimeraListener;
  79
  80   /*
  81    * set if chimera state is being restored from some source - instructs binding
  82    * not to apply default display style when structure set is updated for first
  83    * time.
  84    */
  85   private boolean loadingFromArchive = false;
  86
  87   /*
  88    * flag to indicate if the Chimera viewer should ignore sequence colouring
  89    * events from the structure manager because the GUI is still setting up
  90    */
  91   private boolean loadingFinished = true;
  92
  93   public String fileLoadingError;
  94
  95   /*
  96    * Map of ChimeraModel objects keyed by PDB full local file name
  97    */
  98   private Map<String, List<ChimeraModel>> chimeraMaps = new LinkedHashMap<String, List<ChimeraModel>>();
  99
 100   /*
 101    * the default or current model displayed if the model cannot be identified
 102    * from the selection message
 103    */
 104   private int frameNo = 0;
 105
 106   private String lastCommand;
 107
 108   String lastHighlightCommand;
 109
 110   /*
 111    * incremented every time a load notification is successfully handled -
 112    * lightweight mechanism for other threads to detect when they can start
 113    * referring to new structures.
 114    */
 115   private long loadNotifiesHandled = 0;
 116
 117   /**
 118    * Open a PDB structure file in Chimera and set up mappings from Jalview.
 119    *
 120    * We check if the PDB model id is already loaded in Chimera, if so don't
 121    * reopen it. This is the case if Chimera has opened a saved session file.
 122    *
 123    * @param pe
 124    * @return
 125    */
 126   public boolean openFile(PDBEntry pe)
 127   {
 128     String file = pe.getFile();
 129     try
 130     {
 131       List<ChimeraModel> modelsToMap = new ArrayList<ChimeraModel>();
 132       List<ChimeraModel> oldList = viewer.getModelList();
 133       boolean alreadyOpen = false;
 134
 135       /*
 136        * If Chimera already has this model, don't reopen it, but do remap it.
 137        */
 138       for (ChimeraModel open : oldList)
 139       {
 140         if (open.getModelName().equals(pe.getId()))
 141         {
 142           alreadyOpen = true;
 143           modelsToMap.add(open);
 144         }
 145       }
 146
 147       /*
 148        * If Chimera doesn't yet have this model, ask it to open it, and retrieve
 149        * the model name(s) added by Chimera.
 150        */
 151       if (!alreadyOpen)
 152       {
 153         viewer.openModel(file, pe.getId(), ModelType.PDB_MODEL);
 154         List<ChimeraModel> newList = viewer.getModelList();
 155         // JAL-1728 newList.removeAll(oldList) does not work
 156         for (ChimeraModel cm : newList)
 157         {
 158           if (cm.getModelName().equals(pe.getId()))
 159           {
 160             modelsToMap.add(cm);
 161           }
 162         }
 163       }
 164
 165       chimeraMaps.put(file, modelsToMap);
 166
 167       if (getSsm() != null)
 168       {
 169         getSsm().addStructureViewerListener(this);
 170         // ssm.addSelectionListener(this);
 171         FeatureRenderer fr = getFeatureRenderer(null);
 172         if (fr != null)
 173         {
 174           fr.featuresAdded();
 175         }
 176         refreshGUI();
 177       }
 178       return true;
 179     } catch (Exception q)
 180     {
 181       log("Exception when trying to open model " + file + "\n"
 182               + q.toString());
 183       q.printStackTrace();
 184     }
 185     return false;
 186   }
 187
 188   /**
 189    * Constructor
 190    *
 191    * @param ssm
 192    * @param pdbentry
 193    * @param sequenceIs
 194    * @param chains
 195    * @param protocol
 196    */
 197   public JalviewChimeraBinding(StructureSelectionManager ssm,
 198           PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String protocol)
 199   {
 200     super(ssm, pdbentry, sequenceIs, protocol);
 201     viewer = new ChimeraManager(
 202             new ext.edu.ucsf.rbvi.strucviz2.StructureManager(true));
 203   }
 204
 205   /**
 206    * Start a dedicated HttpServer to listen for Chimera notifications, and tell
 207    * it to start listening
 208    */
 209   public void startChimeraListener()
 210   {
 211     try
 212     {
 213       chimeraListener = new ChimeraListener(this);
 214       viewer.startListening(chimeraListener.getUri());
 215     } catch (BindException e)
 216     {
 217       System.err.println("Failed to start Chimera listener: "
 218               + e.getMessage());
 219     }
 220   }
 221
 222   /**
 223    * Construct a title string for the viewer window based on the data Jalview
 224    * knows about
 225    *
 226    * @param verbose
 227    * @return
 228    */
 229   public String getViewerTitle(boolean verbose)
 230   {
 231     return getViewerTitle("Chimera", verbose);
 232   }
 233
 234   /**
 235    * Tells Chimera to display only the specified chains
 236    *
 237    * @param toshow
 238    */
 239   public void showChains(List<String> toshow)
 240   {
 241     /*
 242      * Construct a chimera command like
 243      *
 244      * ~display #*;~ribbon #*;ribbon :.A,:.B
 245      */
 246     StringBuilder cmd = new StringBuilder(64);
 247     boolean first = true;
 248     for (String chain : toshow)
 249     {
 250       if (!first)
 251       {
 252         cmd.append(",");
 253       }
 254       cmd.append(":.").append(chain);
 255       first = false;
 256     }
 257
 258     /*
 259      * could append ";focus" to this command to resize the display to fill the
 260      * window, but it looks more helpful not to (easier to relate chains to the
 261      * whole)
 262      */
 263     final String command = "~display #*; ~ribbon #*; ribbon "
 264             + cmd.toString();
 265     sendChimeraCommand(command, false);
 266   }
 267
 268   /**
 269    * Close down the Jalview viewer and listener, and (optionally) the associated
 270    * Chimera window.
 271    */
 272   public void closeViewer(boolean closeChimera)
 273   {
 274     getSsm().removeStructureViewerListener(this, this.getPdbFile());
 275     if (closeChimera)
 276     {
 277       viewer.exitChimera();
 278     }
 279     if (this.chimeraListener != null)
 280     {
 281       chimeraListener.shutdown();
 282       chimeraListener = null;
 283     }
 284     lastCommand = null;
 285     viewer = null;
 286
 287     releaseUIResources();
 288   }
 289
 290   public void colourByChain()
 291   {
 292     colourBySequence = false;
 293     sendAsynchronousCommand("rainbow chain", COLOURING_CHIMERA);
 294   }
 295
 296   /**
 297    * Constructs and sends a Chimera command to colour by charge
 298    * <ul>
 299    * <li>Aspartic acid and Glutamic acid (negative charge) red</li>
 300    * <li>Lysine and Arginine (positive charge) blue</li>
 301    * <li>Cysteine - yellow</li>
 302    * <li>all others - white</li>
 303    * </ul>
 304    */
 305   public void colourByCharge()
 306   {
 307     colourBySequence = false;
 308     String command = "color white;color red ::ASP;color red ::GLU;color blue ::LYS;color blue ::ARG;color yellow ::CYS";
 309     sendAsynchronousCommand(command, COLOURING_CHIMERA);
 310   }
 311
 312   /**
 313    * Construct and send a command to align structures against a reference
 314    * structure, based on one or more sequence alignments
 315    *
 316    * @param _alignment
 317    *          an array of alignments to process
 318    * @param _refStructure
 319    *          an array of corresponding reference structures (index into pdb
 320    *          file array); if a negative value is passed, the first PDB file
 321    *          mapped to an alignment sequence is used as the reference for
 322    *          superposition
 323    * @param _hiddenCols
 324    *          an array of corresponding hidden columns for each alignment
 325    */
 326   public void superposeStructures(AlignmentI[] _alignment,
 327           int[] _refStructure, ColumnSelection[] _hiddenCols)
 328   {
 329     StringBuilder allComs = new StringBuilder(128);
 330     String[] files = getPdbFile();
 331
 332     if (!waitForFileLoad(files))
 333     {
 334       return;
 335     }
 336
 337     refreshPdbEntries();
 338     StringBuilder selectioncom = new StringBuilder(256);
 339     for (int a = 0; a < _alignment.length; a++)
 340     {
 341       int refStructure = _refStructure[a];
 342       AlignmentI alignment = _alignment[a];
 343       ColumnSelection hiddenCols = _hiddenCols[a];
 344
 345       if (refStructure >= files.length)
 346       {
 347         System.err.println("Ignoring invalid reference structure value "
 348                 + refStructure);
 349         refStructure = -1;
 350       }
 351
 352       /*
 353        * 'matched' array will hold 'true' for visible alignment columns where
 354        * all sequences have a residue with a mapping to the PDB structure
 355        */
 356       boolean matched[] = new boolean[alignment.getWidth()];
 357       for (int m = 0; m < matched.length; m++)
 358       {
 359         matched[m] = (hiddenCols != null) ? hiddenCols.isVisible(m) : true;
 360       }
 361
 362       SuperposeData[] structures = new SuperposeData[files.length];
 363       for (int f = 0; f < files.length; f++)
 364       {
 365         structures[f] = new SuperposeData(alignment.getWidth());
 366       }
 367
 368       /*
 369        * Calculate the superposable alignment columns ('matched'), and the
 370        * corresponding structure residue positions (structures.pdbResNo)
 371        */
 372       int candidateRefStructure = findSuperposableResidues(alignment,
 373               matched, structures);
 374       if (refStructure < 0)
 375       {
 376         /*
 377          * If no reference structure was specified, pick the first one that has
 378          * a mapping in the alignment
 379          */
 380         refStructure = candidateRefStructure;
 381       }
 382
 383       int nmatched = 0;
 384       for (boolean b : matched)
 385       {
 386         if (b)
 387         {
 388           nmatched++;
 389         }
 390       }
 391       if (nmatched < 4)
 392       {
 393         // TODO: bail out here because superposition illdefined?
 394       }
 395
 396       /*
 397        * Generate select statements to select regions to superimpose structures
 398        */
 399       String[] selcom = new String[files.length];
 400       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 401       {
 402         String chainCd = "." + structures[pdbfnum].chain;
 403         int lpos = -1;
 404         boolean run = false;
 405         StringBuilder molsel = new StringBuilder();
 406         for (int r = 0; r < matched.length; r++)
 407         {
 408           if (matched[r])
 409           {
 410             int pdbResNum = structures[pdbfnum].pdbResNo[r];
 411             if (lpos != pdbResNum - 1)
 412             {
 413               /*
 414                * discontiguous - append last residue now
 415                */
 416               if (lpos != -1)
 417               {
 418                 molsel.append(String.valueOf(lpos));
 419                 molsel.append(chainCd);
 420                 molsel.append(",");
 421               }
 422               run = false;
 423             }
 424             else
 425             {
 426               /*
 427                * extending a contiguous run
 428                */
 429               if (!run)
 430               {
 431                 /*
 432                  * start the range selection
 433                  */
 434                 molsel.append(String.valueOf(lpos));
 435                 molsel.append("-");
 436               }
 437               run = true;
 438             }
 439             lpos = pdbResNum;
 440           }
 441         }
 442
 443         /*
 444          * and terminate final selection
 445          */
 446         if (lpos != -1)
 447         {
 448           molsel.append(String.valueOf(lpos));
 449           molsel.append(chainCd);
 450         }
 451         if (molsel.length() > 1)
 452         {
 453           selcom[pdbfnum] = molsel.toString();
 454           selectioncom.append("#").append(String.valueOf(pdbfnum))
 455                   .append(":");
 456           selectioncom.append(selcom[pdbfnum]);
 457           selectioncom.append(" ");
 458           if (pdbfnum < files.length - 1)
 459           {
 460             selectioncom.append("| ");
 461           }
 462         }
 463         else
 464         {
 465           selcom[pdbfnum] = null;
 466         }
 467       }
 468
 469       StringBuilder command = new StringBuilder(256);
 470       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 471       {
 472         if (pdbfnum == refStructure || selcom[pdbfnum] == null
 473                 || selcom[refStructure] == null)
 474         {
 475           continue;
 476         }
 477         if (command.length() > 0)
 478         {
 479           command.append(";");
 480         }
 481
 482         /*
 483          * Form Chimera match command, from the 'new' structure to the
 484          * 'reference' structure e.g. (50 residues, chain B/A, alphacarbons):
 485          *
 486          * match #1:1-30.B,81-100.B@CA #0:21-40.A,61-90.A@CA
 487          *
 488          * @see
 489          * https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html
 490          */
 491         command.append("match ").append(getModelSpec(pdbfnum)).append(":");
 492         command.append(selcom[pdbfnum]);
 493         command.append("@").append(
 494                 structures[pdbfnum].isRna ? PHOSPHORUS : ALPHACARBON);
 495         // JAL-1757 exclude alternate CA locations
 496         command.append(NO_ALTLOCS);
 497         command.append(" ").append(getModelSpec(refStructure)).append(":");
 498         command.append(selcom[refStructure]);
 499         command.append("@").append(
 500                 structures[refStructure].isRna ? PHOSPHORUS : ALPHACARBON);
 501         command.append(NO_ALTLOCS);
 502       }
 503       if (selectioncom.length() > 0)
 504       {
 505         if (debug)
 506         {
 507           System.out.println("Select regions:\n" + selectioncom.toString());
 508           System.out.println("Superimpose command(s):\n"
 509                   + command.toString());
 510         }
 511         allComs.append("~display all; chain @CA|P; ribbon ")
 512                 .append(selectioncom.toString())
 513                 .append(";" + command.toString());
 514       }
 515     }
 516     if (selectioncom.length() > 0)
 517     {
 518       // TODO: visually distinguish regions that were superposed
 519       if (selectioncom.substring(selectioncom.length() - 1).equals("|"))
 520       {
 521         selectioncom.setLength(selectioncom.length() - 1);
 522       }
 523       if (debug)
 524       {
 525         System.out.println("Select regions:\n" + selectioncom.toString());
 526       }
 527       allComs.append("; ~display all; chain @CA|P; ribbon ")
 528               .append(selectioncom.toString()).append("; focus");
 529       sendChimeraCommand(allComs.toString(), false);
 530     }
 531
 532   }
 533
 534   /**
 535    * Helper method to construct model spec in Chimera format:
 536    * <ul>
 537    * <li>#0 (#1 etc) for a PDB file with no sub-models</li>
 538    * <li>#0.1 (#1.1 etc) for a PDB file with sub-models</li>
 539    * <ul>
 540    * Note for now we only ever choose the first of multiple models. This
 541    * corresponds to the hard-coded Jmol equivalent (compare {1.1}). Refactor in
 542    * future if there is a need to select specific sub-models.
 543    *
 544    * @param pdbfnum
 545    * @return
 546    */
 547   protected String getModelSpec(int pdbfnum)
 548   {
 549     if (pdbfnum < 0 || pdbfnum >= getPdbCount())
 550     {
 551       return "";
 552     }
 553
 554     /*
 555      * For now, the test for having sub-models is whether multiple Chimera
 556      * models are mapped for the PDB file; the models are returned as a response
 557      * to the Chimera command 'list models type molecule', see
 558      * ChimeraManager.getModelList().
 559      */
 560     List<ChimeraModel> maps = chimeraMaps.get(getPdbFile()[pdbfnum]);
 561     boolean hasSubModels = maps != null && maps.size() > 1;
 562     return "#" + String.valueOf(pdbfnum) + (hasSubModels ? ".1" : "");
 563   }
 564
 565   /**
 566    * Launch Chimera, unless an instance linked to this object is already
 567    * running. Returns true if chimera is successfully launched, or already
 568    * running, else false.
 569    *
 570    * @return
 571    */
 572   public boolean launchChimera()
 573   {
 574     if (!viewer.isChimeraLaunched())
 575     {
 576       return viewer.launchChimera(StructureManager.getChimeraPaths());
 577     }
 578     if (viewer.isChimeraLaunched())
 579     {
 580       return true;
 581     }
 582     log("Failed to launch Chimera!");
 583     return false;
 584   }
 585
 586   /**
 587    * Answers true if the Chimera process is still running, false if ended or not
 588    * started.
 589    *
 590    * @return
 591    */
 592   public boolean isChimeraRunning()
 593   {
 594     return viewer.isChimeraLaunched();
 595   }
 596
 597   /**
 598    * Send a command to Chimera, and optionally log any responses.
 599    *
 600    * @param command
 601    * @param logResponse
 602    */
 603   public void sendChimeraCommand(final String command, boolean logResponse)
 604   {
 605     if (viewer == null)
 606     {
 607       // ? thread running after viewer shut down
 608       return;
 609     }
 610     viewerCommandHistory(false);
 611     if (lastCommand == null || !lastCommand.equals(command))
 612     {
 613       // trim command or it may never find a match in the replyLog!!
 614       List<String> lastReply = viewer.sendChimeraCommand(command.trim(),
 615               logResponse);
 616       if (logResponse && debug)
 617       {
 618         log("Response from command ('" + command + "') was:\n" + lastReply);
 619       }
 620     }
 621     viewerCommandHistory(true);
 622     lastCommand = command;
 623   }
 624
 625   /**
 626    * Send a Chimera command asynchronously in a new thread. If the progress
 627    * message is not null, display this message while the command is executing.
 628    *
 629    * @param command
 630    * @param progressMsg
 631    */
 632   protected abstract void sendAsynchronousCommand(String command,
 633           String progressMsg);
 634
 635   /**
 636    * colour any structures associated with sequences in the given alignment
 637    * using the getFeatureRenderer() and getSequenceRenderer() renderers but only
 638    * if colourBySequence is enabled.
 639    */
 640   public void colourBySequence(boolean showFeatures,
 641           jalview.api.AlignmentViewPanel alignmentv)
 642   {
 643     if (!colourBySequence || !loadingFinished)
 644     {
 645       return;
 646     }
 647     if (getSsm() == null)
 648     {
 649       return;
 650     }
 651     String[] files = getPdbFile();
 652
 653     SequenceRenderer sr = getSequenceRenderer(alignmentv);
 654
 655     FeatureRenderer fr = null;
 656     if (showFeatures)
 657     {
 658       fr = getFeatureRenderer(alignmentv);
 659     }
 660     AlignmentI alignment = alignmentv.getAlignment();
 661
 662     for (jalview.structure.StructureMappingcommandSet cpdbbyseq : getColourBySequenceCommands(
 663             files, sr, fr, alignment))
 664     {
 665       for (String command : cpdbbyseq.commands)
 666       {
 667         sendAsynchronousCommand(command, COLOURING_CHIMERA);
 668       }
 669     }
 670   }
 671
 672   /**
 673    * @param files
 674    * @param sr
 675    * @param fr
 676    * @param alignment
 677    * @return
 678    */
 679   protected StructureMappingcommandSet[] getColourBySequenceCommands(
 680           String[] files, SequenceRenderer sr, FeatureRenderer fr,
 681           AlignmentI alignment)
 682   {
 683     return ChimeraCommands.getColourBySequenceCommand(getSsm(), files,
 684             getSequence(), sr, fr, alignment);
 685   }
 686
 687   /**
 688    * @param command
 689    */
 690   protected void executeWhenReady(String command)
 691   {
 692     waitForChimera();
 693     sendChimeraCommand(command, false);
 694     waitForChimera();
 695   }
 696
 697   private void waitForChimera()
 698   {
 699     while (viewer != null && viewer.isBusy())
 700     {
 701       try
 702       {
 703         Thread.sleep(15);
 704       } catch (InterruptedException q)
 705       {
 706       }
 707     }
 708   }
 709
 710   // End StructureListener
 711   // //////////////////////////
 712
 713   /**
 714    * returns the current featureRenderer that should be used to colour the
 715    * structures
 716    *
 717    * @param alignment
 718    *
 719    * @return
 720    */
 721   public abstract FeatureRenderer getFeatureRenderer(
 722           AlignmentViewPanel alignment);
 723
 724   /**
 725    * instruct the Jalview binding to update the pdbentries vector if necessary
 726    * prior to matching the viewer's contents to the list of structure files
 727    * Jalview knows about.
 728    */
 729   public abstract void refreshPdbEntries();
 730
 731   private int getModelNum(String modelFileName)
 732   {
 733     String[] mfn = getPdbFile();
 734     if (mfn == null)
 735     {
 736       return -1;
 737     }
 738     for (int i = 0; i < mfn.length; i++)
 739     {
 740       if (mfn[i].equalsIgnoreCase(modelFileName))
 741       {
 742         return i;
 743       }
 744     }
 745     return -1;
 746   }
 747
 748   /**
 749    * map between index of model filename returned from getPdbFile and the first
 750    * index of models from this file in the viewer. Note - this is not trimmed -
 751    * use getPdbFile to get number of unique models.
 752    */
 753   private int _modelFileNameMap[];
 754
 755   // ////////////////////////////////
 756   // /StructureListener
 757   @Override
 758   public synchronized String[] getPdbFile()
 759   {
 760     if (viewer == null)
 761     {
 762       return new String[0];
 763     }
 764
 765     return chimeraMaps.keySet().toArray(
 766             modelFileNames = new String[chimeraMaps.size()]);
 767   }
 768
 769   /**
 770    * returns the current sequenceRenderer that should be used to colour the
 771    * structures
 772    *
 773    * @param alignment
 774    *
 775    * @return
 776    */
 777   public abstract SequenceRenderer getSequenceRenderer(
 778           AlignmentViewPanel alignment);
 779
 780   /**
 781    * Construct and send a command to highlight zero, one or more atoms. We do
 782    * this by sending an "rlabel" command to show the residue label at that
 783    * position.
 784    */
 785   @Override
 786   public void highlightAtoms(List<AtomSpec> atoms)
 787   {
 788     if (atoms == null || atoms.size() == 0)
 789     {
 790       return;
 791     }
 792
 793     StringBuilder cmd = new StringBuilder(128);
 794     boolean first = true;
 795     boolean found = false;
 796
 797     for (AtomSpec atom : atoms)
 798     {
 799       int pdbResNum = atom.getPdbResNum();
 800       String chain = atom.getChain();
 801       String pdbfile = atom.getPdbFile();
 802       List<ChimeraModel> cms = chimeraMaps.get(pdbfile);
 803       if (cms != null && !cms.isEmpty())
 804       {
 805         if (first)
 806         {
 807           cmd.append("rlabel #").append(cms.get(0).getModelNumber())
 808                   .append(":");
 809         }
 810         else
 811         {
 812           cmd.append(",");
 813         }
 814         first = false;
 815         cmd.append(pdbResNum);
 816         if (!chain.equals(" "))
 817         {
 818           cmd.append(".").append(chain);
 819         }
 820         found = true;
 821       }
 822     }
 823     String command = cmd.toString();
 824
 825     /*
 826      * avoid repeated commands for the same residue
 827      */
 828     if (command.equals(lastHighlightCommand))
 829     {
 830       return;
 831     }
 832
 833     /*
 834      * unshow the label for the previous residue
 835      */
 836     if (lastHighlightCommand != null)
 837     {
 838       viewer.sendChimeraCommand("~" + lastHighlightCommand, false);
 839     }
 840     if (found)
 841     {
 842       viewer.sendChimeraCommand(command, false);
 843     }
 844     this.lastHighlightCommand = command;
 845   }
 846
 847   /**
 848    * Query Chimera for its current selection, and highlight it on the alignment
 849    */
 850   public void highlightChimeraSelection()
 851   {
 852     /*
 853      * Ask Chimera for its current selection
 854      */
 855     List<String> selection = viewer.getSelectedResidueSpecs();
 856
 857     /*
 858      * Parse model number, residue and chain for each selected position,
 859      * formatted as #0:123.A or #1.2:87.B (#model.submodel:residue.chain)
 860      */
 861     List<AtomSpec> atomSpecs = new ArrayList<AtomSpec>();
 862     for (String atomSpec : selection)
 863     {
 864       int colonPos = atomSpec.indexOf(":");
 865       if (colonPos == -1)
 866       {
 867         continue; // malformed
 868       }
 869
 870       int hashPos = atomSpec.indexOf("#");
 871       String modelSubmodel = atomSpec.substring(hashPos + 1, colonPos);
 872       int dotPos = modelSubmodel.indexOf(".");
 873       int modelId = 0;
 874       try
 875       {
 876         modelId = Integer.valueOf(dotPos == -1 ? modelSubmodel
 877                 : modelSubmodel.substring(0, dotPos));
 878       } catch (NumberFormatException e)
 879       {
 880         // ignore, default to model 0
 881       }
 882
 883       String residueChain = atomSpec.substring(colonPos + 1);
 884       dotPos = residueChain.indexOf(".");
 885       int pdbResNum = Integer.parseInt(dotPos == -1 ? residueChain
 886               : residueChain.substring(0, dotPos));
 887
 888       String chainId = dotPos == -1 ? "" : residueChain
 889               .substring(dotPos + 1);
 890
 891       /*
 892        * Work out the pdbfilename from the model number
 893        */
 894       String pdbfilename = modelFileNames[frameNo];
 895       findfileloop: for (String pdbfile : this.chimeraMaps.keySet())
 896       {
 897         for (ChimeraModel cm : chimeraMaps.get(pdbfile))
 898         {
 899           if (cm.getModelNumber() == modelId)
 900           {
 901             pdbfilename = pdbfile;
 902             break findfileloop;
 903           }
 904         }
 905       }
 906       atomSpecs.add(new AtomSpec(pdbfilename, chainId, pdbResNum, 0));
 907     }
 908
 909     /*
 910      * Broadcast the selection (which may be empty, if the user just cleared all
 911      * selections)
 912      */
 913     getSsm().mouseOverStructure(atomSpecs);
 914   }
 915
 916   private void log(String message)
 917   {
 918     System.err.println("## Chimera log: " + message);
 919   }
 920
 921   private void viewerCommandHistory(boolean enable)
 922   {
 923     // log("(Not yet implemented) History "
 924     // + ((debug || enable) ? "on" : "off"));
 925   }
 926
 927   public long getLoadNotifiesHandled()
 928   {
 929     return loadNotifiesHandled;
 930   }
 931
 932   public void setJalviewColourScheme(ColourSchemeI cs)
 933   {
 934     colourBySequence = false;
 935
 936     if (cs == null)
 937     {
 938       return;
 939     }
 940
 941     // Chimera expects RBG values in the range 0-1
 942     final double normalise = 255D;
 943     viewerCommandHistory(false);
 944     StringBuilder command = new StringBuilder(128);
 945
 946     List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
 947             false);
 948     for (String res : residueSet)
 949     {
 950       Color col = cs.findColour(res.charAt(0));
 951       command.append("color " + col.getRed() / normalise + ","
 952               + col.getGreen() / normalise + "," + col.getBlue()
 953               / normalise + " ::" + res + ";");
 954     }
 955
 956     sendAsynchronousCommand(command.toString(), COLOURING_CHIMERA);
 957     viewerCommandHistory(true);
 958   }
 959
 960   /**
 961    * called when the binding thinks the UI needs to be refreshed after a Chimera
 962    * state change. this could be because structures were loaded, or because an
 963    * error has occurred.
 964    */
 965   public abstract void refreshGUI();
 966
 967   @Override
 968   public void setLoadingFromArchive(boolean loadingFromArchive)
 969   {
 970     this.loadingFromArchive = loadingFromArchive;
 971   }
 972
 973   /**
 974    *
 975    * @return true if Chimeral is still restoring state or loading is still going
 976    *         on (see setFinsihedLoadingFromArchive)
 977    */
 978   @Override
 979   public boolean isLoadingFromArchive()
 980   {
 981     return loadingFromArchive && !loadingFinished;
 982   }
 983
 984   /**
 985    * modify flag which controls if sequence colouring events are honoured by the
 986    * binding. Should be true for normal operation
 987    *
 988    * @param finishedLoading
 989    */
 990   @Override
 991   public void setFinishedLoadingFromArchive(boolean finishedLoading)
 992   {
 993     loadingFinished = finishedLoading;
 994   }
 995
 996   /**
 997    * Send the Chimera 'background solid <color>" command.
 998    *
 999    * @see https
1000    *      ://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/background
1001    *      .html
1002    * @param col
1003    */
1004   public void setBackgroundColour(Color col)
1005   {
1006     viewerCommandHistory(false);
1007     double normalise = 255D;
1008     final String command = "background solid " + col.getRed() / normalise
1009             + "," + col.getGreen() / normalise + "," + col.getBlue()
1010             / normalise + ";";
1011     viewer.sendChimeraCommand(command, false);
1012     viewerCommandHistory(true);
1013   }
1014
1015   /**
1016    * Ask Chimera to save its session to the given file. Returns true if
1017    * successful, else false.
1018    *
1019    * @param filepath
1020    * @return
1021    */
1022   public boolean saveSession(String filepath)
1023   {
1024     if (isChimeraRunning())
1025     {
1026       List<String> reply = viewer.sendChimeraCommand("save " + filepath,
1027               true);
1028       if (reply.contains("Session written"))
1029       {
1030         return true;
1031       }
1032       else
1033       {
1034         Cache.log
1035                 .error("Error saving Chimera session: " + reply.toString());
1036       }
1037     }
1038     return false;
1039   }
1040
1041   /**
1042    * Ask Chimera to open a session file. Returns true if successful, else false.
1043    * The filename must have a .py extension for this command to work.
1044    *
1045    * @param filepath
1046    * @return
1047    */
1048   public boolean openSession(String filepath)
1049   {
1050     sendChimeraCommand("open " + filepath, true);
1051     // todo: test for failure - how?
1052     return true;
1053   }
1054
1055   /**
1056    * Returns a list of chains mapped in this viewer. Note this list is not
1057    * currently scoped per structure.
1058    *
1059    * @return
1060    */
1061
1062   /**
1063    * Send a 'focus' command to Chimera to recentre the visible display
1064    */
1065   public void focusView()
1066   {
1067     sendChimeraCommand("focus", false);
1068   }
1069
1070   /**
1071    * Send a 'show' command for all atoms in the currently selected columns
1072    *
1073    * TODO: pull up to abstract structure viewer interface
1074    *
1075    * @param vp
1076    */
1077   public void highlightSelection(AlignmentViewPanel vp)
1078   {
1079     List<Integer> cols = vp.getAlignViewport().getColumnSelection()
1080             .getSelected();
1081     AlignmentI alignment = vp.getAlignment();
1082     StructureSelectionManager sm = getSsm();
1083     for (SequenceI seq : alignment.getSequences())
1084     {
1085       /*
1086        * convert selected columns into sequence positions
1087        */
1088       int[] positions = new int[cols.size()];
1089       int i = 0;
1090       for (Integer col : cols)
1091       {
1092         positions[i++] = seq.findPosition(col);
1093       }
1094       sm.highlightStructure(this, seq, positions);
1095     }
1096   }
1097
1098
1099   @Override
1100   public List<String> getChainNames()
1101   {
1102     return chainNames;
1103   }
1104
1105   public Hashtable<String, String> getChainFile()
1106   {
1107     return chainFile;
1108   }
1109
1110 }