Difference between revisions of "Jmol JavaScript Object/WebGL"

From Jmol
Jump to navigation Jump to search
(Chemdoodle Web Components)
(Browser support)
Line 15: Line 15:
  
 
== Browser support ==
 
== Browser support ==
Browser support is irregular, although growing. Chrome, Safari, Edge are compatible, Firefox may be depending on graphics card drivers. Please check e.g. [http://caniuse.com/#feat=webgl Can I use] for current status.
+
Browser support is irregular, although growing. Current versions of Chrome, Safari, Edge are compatible, Firefox may depend on the update of graphics card drivers. Please check e.g. [http://caniuse.com/#feat=webgl Can I use] for current status.
  
 
== Implementing the WebGL modality ==
 
== Implementing the WebGL modality ==

Revision as of 11:30, 8 November 2015

WebGL modality in JSmol

JSmol has tentatively implemented a modality (additional to the Java and the HTML5 modalities) that makes use of the WebGL technology.

Please, note that this modality does not implement the full set of functionalities of Jmol/JSmol and there are no current plans to develop it further. Help from interested developers/programmers would be welcome.

WebGL is a hardware-accelerated technology for displaying 2D and 3D graphics inside web pages without using any plugins in the browser. It relies on capabilities of the user's graphics card (calculation in the GPU), and so compatibility may be limited, although it is a growing standard feature.

The major advantage of using WebGL is a better quality and faster rendering of the model, rotation, movement, etc., over that obtained with JSmol/HTML5. In exchange, the latter offers a wider compatibility with devices.

Demonstration page: https://chemapps.stolaf.edu/jmol//jsmol/jsmolgl.htm

Hardware support

Old graphics cards may not support WebGL.

Browser support

Browser support is irregular, although growing. Current versions of Chrome, Safari, Edge are compatible, Firefox may depend on the update of graphics card drivers. Please check e.g. Can I use for current status.

Implementing the WebGL modality

You need to be aware that your users/visitors might not have a WebGL-compatible system, so be cautious with your design and offer alternatives.

In order to have JSmol in your pages use the WebGL modality:

  1. your page should call File icon.gifJSmol.GLmol.min.js in addition to File icon.gifJSmol.min.js
  2. the use parameter of the Info variable must be set to WebGL (case-insensitive). You can set it to WebGL HTML5 (that's two values) and it will fall back to regular html5-only JSmol should WebGL be unavailable to the browser.


JmolScript features

Please, if you have experienced with JSmol/WebGL feel free to add items here.

Supported

  • rendering styles for atoms and bonds, cartoons, backbone, trace, ribbons
  • isosurfaces
  • molecular orbitals
  • ...

Not supported

  • background color is ignored (always transparent)
  • echo, labels (not displayed, may pop errors)
  • translucency (always opaque)
  • animation (stops at every frame)
  • vibration (the animations)
  • rockets (helices lack the pointed end), strands (clumsy rotation)
  • mesh (e.g. in MO, clumsy rotation)
  • ...

WebGL-based alternatives to JSmol

There are several programs able to display molecular structures using the WebGL technology. This is a list of some of them, and an attempt for comparison.

GLmol

  • Main page: http://webglmol.osdn.jp/index-en.html

Might have been the first WebGL viewer available. Some of its code has been used in the JSmol WebGL modality. Active development has apparently ceased.

3Dmol.js

  • Main page: http://3dmol.csb.pitt.edu/doc/
  • Demo: http://3dmol.csb.pitt.edu/
  • Article in Bioinformatics, doi:10.1093/bioinformatics/btu829
  • Repository: https://github.com/3dmol/3Dmol.js
  • Library available as a single JavaScript file (including or not jQuery)

Has a very simple embedding mechanism, based on HTML markup or url formatting. Abilities to compute isosurfaces in parallel (using web workers that don’t hang the web browser during the computation). Displays most common bio-molecular representations, labels, select and color abilities.

PV Protein Viewer

By Marco Biasini. Open source.

  • Main page: http://biasmv.github.io/pv/
  • Documentation: http://pv.readthedocs.org/en/latest/intro.html
  • Repository: https://github.com/biasmv/pv

Used by SwissModel and RCSB Protein Data Bank. Very clear documentation. Graphics are stylized but also really clear in their depiction. Common bio-molecular representations are available. Selections are based on javascript and a JSON syntax.

NGL

by Alexander Rose

  • Main page: http://arose.github.io/ngl/doc/#User_manual/Introduction/Welcome
  • Demonstration: http://proteinformatics.charite.de/ngl/html/ngl.html
  • Article in Nucleic Acid Research, doi:10.1093/nar/gkv402
  • Repository: https://github.com/arose/ngl

Beautiful graphic capabilities. Many bio-molecular representations (some unique such as «hyperballs» and «ropes» ). Abilities to act on selections with a Jmol-like syntax.

ChemDoodle Web Components

Free product offered by iChemLabs, LLC, under open-source GPL license.

  • Main page: https://web.chemdoodle.com/
  • Examples: https://web.chemdoodle.com/demos/iza-zeolite-explorer/ http://www.glmol.com/

Handles biomolecular representations and has some capabilities to handle cif files and generate multiple cells. Viewer canvases can be linked to a range of different widgets (spectrum display, 2D formula, etc.). Selection and display is based on the manipulation of JavaScript objects.

iview

By Li, Leung, Nakane and Wong, Chinese University of Hong Kong

  • Main page: http://istar.cse.cuhk.edu.hk/iview/

molmil

Backed by Protein Data Bank Japan

  • Main page: http://pdbj.org/help/molmil

Speck

By Rye Terrell. Public domain.

  • Main page: http://wwwtyro.github.io/speck/
  • Repository: https://github.com/wwwtyro/speck

Offers ambient occlusion rendering

Contributors

AngelHerraez