must specify .CA
[jalview.git] / src / jalview / appletgui / AppletJmol.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer
3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
18  */
19
20 package jalview.appletgui;
21
22 import java.util.*;
23 import java.awt.*;
24 import java.awt.event.*;
25
26 import jalview.datamodel.*;
27 import jalview.structure.*;
28 import jalview.io.*;
29
30 import org.jmol.api.*;
31 import org.jmol.adapter.smarter.SmarterJmolAdapter;
32
33 import org.jmol.popup.*;
34 import jalview.schemes.*;
35
36
37 public class AppletJmol extends Frame
38     implements  StructureListener, JmolStatusListener,
39     KeyListener, ActionListener, ItemListener
40
41 {
42   Menu fileMenu = new Menu("File");
43   Menu viewMenu = new Menu("View");
44   Menu coloursMenu = new Menu("Colours");
45   Menu chainMenu = new Menu("Show Chain");
46   Menu helpMenu = new Menu("Help");
47   MenuItem mappingMenuItem = new MenuItem("View Mapping");
48
49   CheckboxMenuItem seqColour = new CheckboxMenuItem("By Sequence", true);
50   MenuItem chain = new MenuItem("By Chain");
51   MenuItem charge = new MenuItem("Charge & Cysteine");
52   MenuItem zappo = new MenuItem("Zappo");
53   MenuItem taylor = new MenuItem("Taylor");
54   MenuItem hydro = new MenuItem("Hydrophobicity");
55   MenuItem helix = new MenuItem("Helix Propensity");
56   MenuItem strand = new MenuItem("Strand Propensity");
57   MenuItem turn = new MenuItem("Turn Propensity");
58   MenuItem buried = new MenuItem("Buried Index");
59   MenuItem user = new MenuItem("User Defined Colours");
60
61   MenuItem jmolHelp = new MenuItem("Jmol Help");
62
63   JmolViewer viewer;
64   JmolPopup jmolpopup;
65
66   Panel scriptWindow;
67   TextField inputLine;
68   TextArea history;
69   SequenceI[] sequence;
70   String [] chains;
71   StructureSelectionManager ssm;
72   RenderPanel renderPanel;
73   AlignmentPanel ap;
74   String fileLoadingError;
75   boolean loadedInline;
76   PDBEntry pdbentry;
77   boolean colourBySequence = true;
78   Vector atomsPicked = new Vector();
79
80   public AppletJmol(PDBEntry pdbentry,
81                     SequenceI[] seq,
82                     String[] chains,
83                     AlignmentPanel ap,
84                     String protocol)
85   {
86     this.ap = ap;
87     this.sequence = seq;
88     this.chains = chains;
89     this.pdbentry = pdbentry;
90
91    String alreadyMapped = StructureSelectionManager
92         .getStructureSelectionManager()
93         .alreadyMappedToFile(pdbentry.getId());
94
95     if (alreadyMapped != null)
96     {
97        StructureSelectionManager.getStructureSelectionManager()
98             .setMapping(seq, chains, pdbentry.getFile(), protocol);
99        //PROMPT USER HERE TO ADD TO NEW OR EXISTING VIEW?
100        //FOR NOW, LETS JUST OPEN A NEW WINDOW
101     }
102
103     renderPanel = new RenderPanel();
104
105     this.add(renderPanel, BorderLayout.CENTER);
106     viewer = JmolViewer.allocateViewer(renderPanel, new SmarterJmolAdapter());
107
108     viewer.setAppletContext("jalview",
109                        ap.av.applet.getDocumentBase(),
110                             ap.av.applet.getCodeBase(),
111                             null);
112
113     viewer.setJmolStatusListener(this);
114
115     jmolpopup = JmolPopup.newJmolPopup(viewer);
116
117     this.addWindowListener(new WindowAdapter()
118         {
119           public void windowClosing(WindowEvent evt)
120           {
121             closeViewer();
122           }
123         });
124
125     MenuBar menuBar = new MenuBar();
126     menuBar.add(fileMenu);
127     fileMenu.add(mappingMenuItem);
128     menuBar.add(viewMenu);
129     mappingMenuItem.addActionListener(this);
130     viewMenu.add(chainMenu);
131     menuBar.add(coloursMenu);
132     menuBar.add(helpMenu);
133
134     charge.addActionListener(this);
135     hydro.addActionListener(this);
136     chain.addActionListener(this);
137     seqColour.addItemListener(this);
138     zappo.addActionListener(this);
139     taylor.addActionListener(this);
140     helix.addActionListener(this);
141     strand.addActionListener(this);
142     turn.addActionListener(this);
143     buried.addActionListener(this);
144     user.addActionListener(this);
145
146     jmolHelp.addActionListener(this);
147
148     coloursMenu.add(seqColour);
149     coloursMenu.add(chain);
150     coloursMenu.add(charge);
151     coloursMenu.add(zappo);
152     coloursMenu.add(taylor);
153     coloursMenu.add(hydro);
154     coloursMenu.add(helix);
155     coloursMenu.add(strand);
156     coloursMenu.add(turn);
157     coloursMenu.add(buried);
158     coloursMenu.add(user);
159
160     helpMenu.add(jmolHelp);
161
162     this.setMenuBar(menuBar);
163
164     if(pdbentry.getFile()!=null)
165     {
166       if (protocol.equals(AppletFormatAdapter.PASTE))
167         loadInline(pdbentry.getFile());
168       else
169           viewer.openFile(pdbentry.getFile());
170     }
171
172     jalview.bin.JalviewLite.addFrame(this, "Jmol", 400,400);
173   }
174
175   public void loadInline(String string)
176   {
177     loadedInline = true;
178     viewer.openStringInline(string);
179   }
180
181
182   void setChainMenuItems(Vector chains)
183   {
184     chainMenu.removeAll();
185
186     MenuItem menuItem = new MenuItem("All");
187     menuItem.addActionListener(this);
188
189     chainMenu.add(menuItem);
190
191     CheckboxMenuItem menuItemCB;
192     for (int c = 0; c < chains.size(); c++)
193     {
194       menuItemCB = new CheckboxMenuItem(chains.elementAt(c).toString(), true);
195       menuItemCB.addItemListener(this);
196       chainMenu.add(menuItemCB);
197     }
198   }
199
200   boolean allChainsSelected = false;
201   void centerViewer()
202   {
203     StringBuffer cmd = new StringBuffer();
204     for (int i = 0; i < chainMenu.getItemCount(); i++)
205     {
206       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
207       {
208         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
209         if (item.getState())
210           cmd.append(":" + item.getLabel() + " or ");
211       }
212     }
213
214     if (cmd.length() > 0)
215       cmd.setLength(cmd.length() - 4);
216
217     viewer.evalString("select *;restrict "
218                       + cmd + ";cartoon;center " + cmd);
219   }
220
221
222   void closeViewer()
223   {
224     viewer.setModeMouse(org.jmol.viewer.JmolConstants.MOUSE_NONE);
225     viewer.evalStringQuiet("zap");
226     viewer.setJmolStatusListener(null);
227     viewer = null;
228
229     //We'll need to find out what other
230     // listeners need to be shut down in Jmol
231     StructureSelectionManager
232         .getStructureSelectionManager()
233         .removeStructureViewerListener(this, pdbentry.getId());
234
235     this.setVisible(false);
236   }
237
238   public void actionPerformed(ActionEvent evt)
239   {
240     if(evt.getSource()==mappingMenuItem)
241     {
242       jalview.appletgui.CutAndPasteTransfer cap
243           = new jalview.appletgui.CutAndPasteTransfer(false, null);
244       Frame frame = new Frame();
245       frame.add(cap);
246
247       jalview.bin.JalviewLite.addFrame(frame, "PDB - Sequence Mapping", 550,
248                                        600);
249       cap.setText(
250           StructureSelectionManager.getStructureSelectionManager().printMapping(
251               pdbentry.getFile())
252           );
253     }
254     else if (evt.getSource() == charge)
255     {
256       colourBySequence = false;
257       seqColour.setState(false);
258       viewer.evalStringQuiet("select *;color white;select ASP,GLU;color red;"
259                       +"select LYS,ARG;color blue;select CYS;color yellow");
260     }
261
262     else if (evt.getSource() == chain)
263     {
264       colourBySequence = false;
265       seqColour.setState(false);
266       viewer.evalStringQuiet("select *;color chain");
267     }
268     else if (evt.getSource() == zappo)
269     {
270       setJalviewColourScheme(new ZappoColourScheme());
271     }
272     else if (evt.getSource() == taylor)
273     {
274      setJalviewColourScheme(new TaylorColourScheme());
275     }
276     else if (evt.getSource() == hydro)
277     {
278       setJalviewColourScheme(new HydrophobicColourScheme());
279     }
280     else if (evt.getSource() == helix)
281     {
282       setJalviewColourScheme(new HelixColourScheme());
283     }
284     else if (evt.getSource() == strand)
285     {
286       setJalviewColourScheme(new StrandColourScheme());
287     }
288     else if (evt.getSource() == turn)
289     {
290       setJalviewColourScheme(new TurnColourScheme());
291     }
292     else if (evt.getSource() == buried)
293     {
294       setJalviewColourScheme(new BuriedColourScheme());
295     }
296     else if (evt.getSource() == user)
297     {
298       new UserDefinedColours(this);
299     }
300     else if(evt.getSource() == jmolHelp)
301     {
302       try{
303         ap.av.applet.getAppletContext().showDocument(
304             new java.net.URL("http://jmol.sourceforge.net/docs/JmolUserGuide/"),
305             "jmolHelp");
306       }catch(java.net.MalformedURLException ex){}
307     }
308     else
309     {
310       allChainsSelected = true;
311       for (int i = 0; i < chainMenu.getItemCount(); i++)
312       {
313         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
314           ( (CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
315       }
316       centerViewer();
317       allChainsSelected = false;
318     }
319   }
320
321   public void setJalviewColourScheme(ColourSchemeI cs)
322   {
323     colourBySequence = false;
324     seqColour.setState(false);
325
326     if(cs==null)
327       return;
328
329     String res;
330     int index;
331     Color col;
332
333     Enumeration en = ResidueProperties.aa3Hash.keys();
334     StringBuffer command = new StringBuffer("select *;color white;");
335     while(en.hasMoreElements())
336     {
337       res = en.nextElement().toString();
338       index = ((Integer) ResidueProperties.aa3Hash.get(res)).intValue();
339       if(index>20)
340         continue;
341
342       col = cs.findColour(ResidueProperties.aa[index].charAt(0));
343
344       command.append("select "+res+";color["
345                         + col.getRed() + ","
346                         + col.getGreen() + ","
347                         + col.getBlue() + "];");
348     }
349
350     viewer.evalStringQuiet(command.toString());
351   }
352
353   public void itemStateChanged(ItemEvent evt)
354   {
355     if (evt.getSource() == seqColour)
356     {
357       colourBySequence = seqColour.getState();
358       colourBySequence(ap);
359     }
360     else if (!allChainsSelected)
361       centerViewer();
362   }
363
364   public void keyPressed(KeyEvent evt)
365   {
366     if (evt.getKeyCode() == KeyEvent.VK_ENTER
367         && scriptWindow.isVisible())
368     {
369       viewer.evalString(inputLine.getText());
370       history.append("\n$ "+inputLine.getText());
371       inputLine.setText("");
372     }
373
374   }
375
376   public void keyTyped(KeyEvent evt)
377   {  }
378
379   public void keyReleased(KeyEvent evt){}
380
381   //////////////////////////////////
382   ///StructureListener
383   public String getPdbFile()
384   {
385     return "???";
386   }
387
388
389
390   String lastMessage;
391   public void mouseOverStructure(int atomIndex, String strInfo)
392   {
393       int pdbResNum;
394
395       int chainSeparator = strInfo.indexOf(":");
396
397       if(chainSeparator==-1)
398         chainSeparator = strInfo.indexOf(".");
399
400       pdbResNum = Integer.parseInt(
401           strInfo.substring(strInfo.indexOf("]")+ 1, chainSeparator));
402
403       String chainId;
404
405       if (strInfo.indexOf(":") > -1)
406         chainId = strInfo.substring
407             (strInfo.indexOf(":")+1, strInfo.indexOf("."));
408       else
409       {
410         chainId = " ";
411       }
412
413       if (lastMessage == null || !lastMessage.equals(strInfo))
414         ssm.mouseOverStructure(pdbResNum, chainId, pdbentry.getFile());
415
416       lastMessage = strInfo;
417   }
418
419   StringBuffer resetLastRes = new StringBuffer();
420   StringBuffer eval = new StringBuffer();
421
422   public void highlightAtom(int atomIndex, int pdbResNum, String chain, String pdbfile)
423   {
424     if (!pdbfile.equals(pdbentry.getFile()))
425       return;
426
427     if (resetLastRes.length() > 0)
428     {
429       viewer.evalStringQuiet(resetLastRes.toString());
430     }
431
432     eval.setLength(0);
433     eval.append("select " + pdbResNum);
434
435     resetLastRes.setLength(0);
436     resetLastRes.append("select " + pdbResNum);
437
438     if (!chain.equals(" "))
439     {
440       eval.append(":" + chain);
441       resetLastRes.append(":" + chain);
442     }
443
444     eval.append(";wireframe 100;"+eval.toString()+".CA;");
445
446     resetLastRes.append(";wireframe 0;"+resetLastRes.toString()+".CA;spacefill 0;");
447
448     eval.append("spacefill 200;select none");
449
450     viewer.evalStringQuiet(eval.toString());
451
452   }
453
454   public void updateColours(Object source)
455   {
456     colourBySequence( (AlignmentPanel) source);
457   }
458
459 //End StructureListener
460 ////////////////////////////
461
462   public Color getColour(int atomIndex, int pdbResNum, String chain, String pdbfile)
463   {
464     if (!pdbfile.equals(pdbentry.getFile()))
465       return null;
466
467     return new Color(viewer.getAtomArgb(atomIndex));
468   }
469
470   FeatureRenderer fr;
471   String lastCommand;
472   public void colourBySequence(AlignmentPanel ap)
473   {
474     if(!colourBySequence)
475       return;
476
477
478     StructureMapping[] mapping = ssm.getMapping(pdbentry.getFile());
479
480     if (mapping.length < 1)
481       return;
482
483     SequenceRenderer sr = new SequenceRenderer(ap.av);
484
485     boolean showFeatures = false;
486     if (ap.av.showSequenceFeatures)
487     {
488       showFeatures = true;
489       if (fr == null)
490       {
491         fr = new jalview.appletgui.FeatureRenderer(ap.av);
492       }
493
494       fr.transferSettings(ap.seqPanel.seqCanvas.getFeatureRenderer());
495     }
496
497     StringBuffer command = new StringBuffer();
498
499     int lastPos = -1;
500     for (int s = 0; s < sequence.length; s++)
501     {
502       for (int m = 0; m < mapping.length; m++)
503       {
504         if (mapping[m].getSequence() == sequence[s]
505             && ap.av.alignment.findIndex(sequence[s])>-1)
506         {
507           for (int r = 0; r < sequence[s].getLength(); r++)
508           {
509             int pos = mapping[m].getPDBResNum(
510                 sequence[s].findPosition(r));
511
512             if (pos < 1 || pos==lastPos)
513               continue;
514
515             lastPos = pos;
516
517             Color col = sr.getResidueBoxColour(sequence[s], r);
518
519             if (showFeatures)
520               col = fr.findFeatureColour(col, sequence[s], r);
521
522             if (command.toString().endsWith(":" + mapping[m].getChain()+
523                                             ";color["
524                                             + col.getRed() + ","
525                                             + col.getGreen() + ","
526                                             + col.getBlue() + "]"))
527             {
528               command = condenseCommand(command.toString(), pos);
529               continue;
530             }
531
532             command.append(";select " + pos);
533
534             if (!mapping[m].getChain().equals(" "))
535             {
536               command.append(":" + mapping[m].getChain());
537             }
538
539             command.append(";color["
540                              + col.getRed() + ","
541                              + col.getGreen() + ","
542                              + col.getBlue() + "]");
543
544           }
545           break;
546         }
547       }
548     }
549
550     if (lastCommand == null || !lastCommand.equals(command.toString()))
551       viewer.evalStringQuiet(command.toString());
552
553     lastCommand = command.toString();
554   }
555
556   StringBuffer condenseCommand(String command, int pos)
557   {
558
559     StringBuffer sb = new StringBuffer(command.substring(0, command.lastIndexOf("select")+7));
560
561     command = command.substring(sb.length());
562
563     String start;
564
565     if (command.indexOf("-") > -1)
566     {
567       start = command.substring(0,command.indexOf("-"));
568     }
569     else
570     {
571       start = command.substring(0, command.indexOf(":"));
572     }
573
574     sb.append(start+"-"+pos+command.substring(command.indexOf(":")));
575
576     return sb;
577   }
578
579   /////////////////////////////////
580   //JmolStatusListener
581
582   public String eval(String strEval)
583   {
584    // System.out.println(strEval);
585    //"# 'eval' is implemented only for the applet.";
586     return null;
587   }
588
589   public void createImage(String file, String type, int quality)
590   {}
591
592   public void setCallbackFunction(String callbackType,
593                                   String callbackFunction)
594   {}
595
596   public void notifyFileLoaded(String fullPathName, String fileName,
597                                String modelName, Object clientFile,
598                                String errorMsg)
599   {
600     if(errorMsg!=null)
601     {
602       fileLoadingError = errorMsg;
603       repaint();
604       return;
605     }
606
607     fileLoadingError = null;
608
609     if (fileName != null)
610     {
611       //FILE LOADED OK
612       jmolpopup.updateComputedMenus();
613             viewer.evalStringQuiet(
614           "select backbone;restrict;cartoon;wireframe off;spacefill off");
615
616       ssm = StructureSelectionManager.getStructureSelectionManager();
617
618       MCview.PDBfile pdb;
619       if (loadedInline)
620       {
621         pdb = ssm.setMapping(sequence,chains,
622                                 pdbentry.getFile(),
623                                 AppletFormatAdapter.PASTE);
624         pdbentry.setFile("INLINE"+pdb.id);
625       }
626       else
627       {
628          pdb = ssm.setMapping(sequence,chains,
629                               pdbentry.getFile(),
630                               AppletFormatAdapter.URL);
631       }
632
633       pdbentry.setId(pdb.id);
634
635       ssm.addStructureViewerListener(this);
636
637       Vector chains = new Vector();
638       for (int i = 0; i < pdb.chains.size(); i++)
639       {
640         chains.addElement( ( (MCview.PDBChain) pdb.chains.elementAt(i)).id);
641       }
642       setChainMenuItems(chains);
643
644       colourBySequence(ap);
645
646       StringBuffer title = new StringBuffer(sequence[0].getName() + ":" +
647                                             pdbentry.getId());
648
649       if (pdbentry.getProperty() != null)
650       {
651         if (pdbentry.getProperty().get("method") != null)
652         {
653           title.append(" Method: ");
654           title.append(pdbentry.getProperty().get("method"));
655         }
656         if (pdbentry.getProperty().get("chains") != null)
657         {
658           title.append(" Chain:");
659           title.append(pdbentry.getProperty().get("chains"));
660         }
661       }
662
663       this.setTitle(title.toString());
664
665     }
666     else
667       return;
668   }
669
670   public void notifyFrameChanged(int frameNo)
671   {
672     boolean isAnimationRunning = (frameNo <= -2);
673   }
674
675   public void notifyScriptStart(String statusMessage, String additionalInfo)
676   {}
677
678   public void sendConsoleEcho(String strEcho)
679   {
680     if (scriptWindow == null)
681       showConsole(true);
682
683     history.append("\n"+strEcho);
684   }
685
686   public void sendConsoleMessage(String strStatus)
687   {
688     if(history!=null && strStatus!=null
689        && !strStatus.equals("Script completed"))
690     {
691       history.append("\n"+strStatus);
692     }
693   }
694
695   public void notifyScriptTermination(String strStatus, int msWalltime)
696   {  }
697
698   public void handlePopupMenu(int x, int y)
699   {
700     jmolpopup.show(x, y);
701   }
702
703   public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
704   {
705     notifyAtomPicked(iatom, strMeasure);
706   }
707
708   public void notifyNewDefaultModeMeasurement(int count, String strInfo)
709   {}
710
711   public void notifyAtomPicked(int atomIndex, String strInfo)
712   {
713
714     int chainSeparator = strInfo.indexOf(":");
715
716     if(chainSeparator==-1)
717       chainSeparator = strInfo.indexOf(".");
718
719     String picked =
720         strInfo.substring(strInfo.indexOf("]")+ 1, chainSeparator);
721
722
723     if (strInfo.indexOf(":") > -1)
724       picked+=strInfo.substring(strInfo.indexOf(":")+1,
725                                strInfo.indexOf("."));
726
727     picked+=".CA";
728
729     if (!atomsPicked.contains(picked))
730     {
731       viewer.evalString("select "+picked+";label %n %r:%c");
732       atomsPicked.addElement(picked);
733     }
734     else
735     {
736       viewer.evalString("select "+picked+";label off");
737       atomsPicked.removeElement(picked);
738     }
739   }
740
741   public void notifyAtomHovered(int atomIndex, String strInfo)
742   {
743     mouseOverStructure(atomIndex, strInfo);
744   }
745
746   public void sendSyncScript(String script, String appletName)
747   {}
748
749   public void showUrl(String url)
750   {
751     try{
752       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
753           "jmolOutput");
754     }catch(java.net.MalformedURLException ex)
755     {}
756   }
757
758   public void showConsole(boolean showConsole)
759   {
760     if (scriptWindow == null)
761     {
762       scriptWindow = new Panel(new BorderLayout());
763       inputLine = new TextField();
764       history = new TextArea(5, 40);
765       scriptWindow.add(history, BorderLayout.CENTER);
766       scriptWindow.add(inputLine, BorderLayout.SOUTH);
767       add(scriptWindow, BorderLayout.SOUTH);
768       scriptWindow.setVisible(false);
769       history.setEditable(false);
770       inputLine.addKeyListener(this);
771     }
772
773     scriptWindow.setVisible(!scriptWindow.isVisible());
774     validate();
775   }
776
777   public float functionXY(String functionName, int x, int y)
778   {
779     return 0;
780   }
781
782   ///End JmolStatusListener
783   ///////////////////////////////
784
785
786   class RenderPanel
787       extends Panel
788   {
789     Dimension currentSize = new Dimension();
790     Rectangle rectClip = new Rectangle();
791
792     public void update(Graphics g) {
793       paint(g);
794     }
795     public void paint(Graphics g)
796     {
797       currentSize = this.getSize();
798       rectClip = g.getClipBounds();
799
800       if (viewer == null)
801       {
802         g.setColor(Color.black);
803         g.fillRect(0, 0, currentSize.width, currentSize.height);
804         g.setColor(Color.white);
805         g.setFont(new Font("Verdana", Font.BOLD, 14));
806         g.drawString("Retrieving PDB data....", 20, currentSize.height / 2);
807       }
808       else
809       {
810         viewer.renderScreenImage(g, currentSize, rectClip);
811       }
812     }
813   }
814
815 }