Difference between revisions of "Applications Embedding Jmol"

From Jmol
Jump to navigation Jump to search
m (explain dual link)
(link to new page Programmatic_Access_to_Jmol)
Line 21: Line 21:
 
=== How to embed Jmol into an application ===
 
=== How to embed Jmol into an application ===
  
* a very good start is the [http://jmol.svn.sourceforge.net/viewcvs.cgi/jmol/trunk/Jmol/examples/basic/Integration.java?view=markup Integration.java] out of [http://jmol.svn.sourceforge.net/viewcvs.cgi/jmol/trunk/Jmol/ Jmol SVN].
+
* A very good start is the [http://jmol.svn.sourceforge.net/viewcvs.cgi/jmol/trunk/Jmol/examples/basic/Integration.java?view=markup Integration.java] out of [http://jmol.svn.sourceforge.net/viewcvs.cgi/jmol/trunk/Jmol/ Jmol SVN].
* to see how [http://www.efamily.org.uk/software/dasclients/spice/spice.shtml Spice] is integrating Jmol, please have a look [http://www.derkholm.net/svn/repos/spice/trunk/src/org/biojava/spice/jmol/ here].
+
* To see how [http://www.efamily.org.uk/software/dasclients/spice/spice.shtml Spice] is integrating Jmol, please have a look [http://www.derkholm.net/svn/repos/spice/trunk/src/org/biojava/spice/jmol/ here].
* a special page is devoted to using Jmol as 3D viewer for CDK based projects: [[Jmol Cdk Integration]].
+
* A special page is devoted to using Jmol as 3D viewer for CDK based projects: [[Jmol Cdk Integration]].
 +
* Another example: [[Programmatic Access to Jmol]]
  
 
Most interaction with Jmol will happen by sending RasmolScript - like commands to Jmol. This is nicely documented by the [http://jmol.svn.sourceforge.net/viewcvs.cgi/jmol/trunk/Jmol/examples/basic/Integration.java?view=markup Integration.java] example. It is also possible to get data back out of Jmol. This can be done by accessing the JmolViewer class. This might be replaced by an Interface in the future.
 
Most interaction with Jmol will happen by sending RasmolScript - like commands to Jmol. This is nicely documented by the [http://jmol.svn.sourceforge.net/viewcvs.cgi/jmol/trunk/Jmol/examples/basic/Integration.java?view=markup Integration.java] example. It is also possible to get data back out of Jmol. This can be done by accessing the JmolViewer class. This might be replaced by an Interface in the future.

Revision as of 13:12, 27 August 2009

Jmol / JSmol Applications

Applications using Jmol

Jmol users, please add here your favorite Java applications that embed Jmol.

(There is another page for operating systems and software suites that include Jmol.)

  • BioClipse.
  • CaGe (mirror) - the "Chemical & abstract Graph environment" is a collection of graph generators for GNU Linux and Mac OS X, that uses Jmol as one of its visualizers.
  • ChemPad renders in Jmol 3D models calculated on-the-fly from a formula sketched by hand in a tablet PC.
  • iBabel - A GUI for cheminfomatics toolkit Openbabel, iBabel uses embeded applets to display structures.
  • Janocchio is an applet and application; in addition to using Jmol display capabilities, it calculates both H-H and H-C 3-bond NMR coupling constants and NOEs from a three-dimensional structure. © Eli Lilly and Co. Open source and hosted af SF.
  • Molecular Workbench - A Molecular Simulation Tool.
  • PFAAT - Protein Family Alignment Annotation Tool.
  • ProteinGlimpse is a free widget for visualizing macromolecules retrieved from the Protein Data Bank or from local disk. It is a dashboard application for Mac OS X that uses the JmolApplet.
  • Sage is a computational platform with the goal of providing a viable free and open-source alternative to Matlab, Maple, Mathematica and Magma. It uses Jmol for its 3D interactive plotting.
  • Spice - Spice is a DAS client for distributed annotation of protein sequences and structures. A java webstart version can be run from online.
  • STRAP - Alignment Program for Proteins and workbench for protein structures.
  • Taverna.

How to embed Jmol into an application

Most interaction with Jmol will happen by sending RasmolScript - like commands to Jmol. This is nicely documented by the Integration.java example. It is also possible to get data back out of Jmol. This can be done by accessing the JmolViewer class. This might be replaced by an Interface in the future.

One example of getting data out of Jmol is by adding a MouseListener to the Panel that contains the JmolViewer instance. e.g.

 public void mouseMoved(MouseEvent e) {
 
   int pos = viewer.findNearestAtomIndex( e.getX(), e.getY() );
   if ( pos == -1 ) { return ; }
 
   String chainId = viewer.getAtomChain( pos ) ;
   String seqCode = viewer.getAtomSequenceCode( pos ) ;
   // ... do something in your application
 }

When retreiving the "seqCode" for an Atom, the Insertion Code of PDB files is appended. Note the Jmol notation of insertion codes: e.g. 122^A, to distinguish from the Rasmol command 122A, which would select residue 122 of chain A.

A Note on JmolStatusListener

If your application needs to be notified of Jmol events, then you must create an interface to Jmol by implementing org.jmol.api.JmolStatusListener. I stumbled for some time before discovering that the notifyFrameChanged() event handler must include updateComputedMenus() on the JmolPopup object. Without this, the menu will mostly contain ghosted items.