Class JmolSymmetryScriptGeneratorH
java.lang.Object
org.biojava.nbio.structure.symmetry.jmolScript.JmolSymmetryScriptGenerator
org.biojava.nbio.structure.symmetry.jmolScript.JmolSymmetryScriptGeneratorH
- Author:
- Peter
-
Constructor Summary
ConstructorDescriptionJmolSymmetryScriptGeneratorH
(HelixAxisAligner helixAxisAligner, String name) -
Method Summary
Modifier and TypeMethodDescriptionReturns a Jmol script that colors subunits by their sequence cluster ids.Returns a Jmol script that colors the subunits of a structure by different colorsReturns a Jmol script that colors subunits to highlight the symmetry within a structure Different subunits should have a consistent color scheme or different shade of the same colorsdrawAxes()
Returns a Jmol script that draws symmetry or inertia axes for a structure.Returns a Jmol script that draws an invisible polyhedron around a structure.Returns a Jmol script to set the default orientation for a structureprotected double
Returns the maximum extension (length) of structuregetOrientation
(int index) Returns a Jmol script that sets a specific orientationint
Returns the number of orientations available for this structuregetOrientationName
(int index) Returns the name of a specific orientationgetOrientationWithZoom
(int index) Returns a Jmol script that sets a specific orientation and zoom to draw either axes or polyhedronjavax.vecmath.Matrix4d
Returns transformation matrix to orient structureint
getZoom()
Returns the Jmol zoom to fit polyhedron and symmetry axes.hideAxes()
Returns a Jmol script to hide axesReturns a Jmol script that displays a symmetry polyhedron and symmetry axes and then loop through different orientationsvoid
setDefaultColoring
(String colorScript) Sets a default Jmol script used for coloring.void
setOnTheFly
(boolean onTheFly) Sets the type of bioassembly to be colored.showAxes()
Returns a Jmol script to show axesMethods inherited from class org.biojava.nbio.structure.symmetry.jmolScript.JmolSymmetryScriptGenerator
f1Dot2, fDot2, getInstance, getInstantaneousOrientation, getJmolColor, getJmolColorScript, getJmolLigandScript, getJmolPoint, jMolFloat
-
Constructor Details
-
JmolSymmetryScriptGeneratorH
-
-
Method Details
-
setOnTheFly
public void setOnTheFly(boolean onTheFly) Description copied from class:JmolSymmetryScriptGenerator
Sets the type of bioassembly to be colored. If set to true, it will generate a Jmol script for a bioassembly generated by Jmol on the fly. If set to false, it will generate Jmol script for a bioassembly file read by Jmol.- Specified by:
setOnTheFly
in classJmolSymmetryScriptGenerator
-
getZoom
public int getZoom()Description copied from class:JmolSymmetryScriptGenerator
Returns the Jmol zoom to fit polyhedron and symmetry axes. This zoom level should be used so that the polyhedron and symmetry axes are not cutoff.- Specified by:
getZoom
in classJmolSymmetryScriptGenerator
- Returns:
-
getDefaultOrientation
Returns a Jmol script to set the default orientation for a structure- Specified by:
getDefaultOrientation
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
getOrientationCount
public int getOrientationCount()Description copied from class:JmolSymmetryScriptGenerator
Returns the number of orientations available for this structure- Specified by:
getOrientationCount
in classJmolSymmetryScriptGenerator
- Returns:
- number of orientations
-
getOrientation
Description copied from class:JmolSymmetryScriptGenerator
Returns a Jmol script that sets a specific orientation- Specified by:
getOrientation
in classJmolSymmetryScriptGenerator
- Parameters:
index
- orientation index- Returns:
- Jmol script
-
getOrientationWithZoom
Returns a Jmol script that sets a specific orientation and zoom to draw either axes or polyhedron- Specified by:
getOrientationWithZoom
in classJmolSymmetryScriptGenerator
- Parameters:
index
- orientation index- Returns:
- Jmol script
-
getOrientationName
Returns the name of a specific orientation- Specified by:
getOrientationName
in classJmolSymmetryScriptGenerator
- Parameters:
index
- orientation index- Returns:
- name of orientation
-
getTransformation
public javax.vecmath.Matrix4d getTransformation()Description copied from class:JmolSymmetryScriptGenerator
Returns transformation matrix to orient structure- Specified by:
getTransformation
in classJmolSymmetryScriptGenerator
- Returns:
- transformation matrix
-
setDefaultColoring
Description copied from class:JmolSymmetryScriptGenerator
Sets a default Jmol script used for coloring. This method is used in local symmetry cases to color those subunits that are not related by symmetry.- Specified by:
setDefaultColoring
in classJmolSymmetryScriptGenerator
-
drawPolyhedron
Returns a Jmol script that draws an invisible polyhedron around a structure. Use showPolyhedron() and hidePolyhedron() to toggle visibility.- Specified by:
drawPolyhedron
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
hidePolyhedron
- Specified by:
hidePolyhedron
in classJmolSymmetryScriptGenerator
-
showPolyhedron
- Specified by:
showPolyhedron
in classJmolSymmetryScriptGenerator
-
drawAxes
Returns a Jmol script that draws symmetry or inertia axes for a structure. Use showAxes() and hideAxes() to toggle visibility.- Specified by:
drawAxes
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
hideAxes
Returns a Jmol script to hide axes- Specified by:
hideAxes
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
showAxes
Returns a Jmol script to show axes- Specified by:
showAxes
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
playOrientations
Returns a Jmol script that displays a symmetry polyhedron and symmetry axes and then loop through different orientations- Specified by:
playOrientations
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
colorBySubunit
Returns a Jmol script that colors the subunits of a structure by different colors- Specified by:
colorBySubunit
in classJmolSymmetryScriptGenerator
- Returns:
-
colorBySequenceCluster
Returns a Jmol script that colors subunits by their sequence cluster ids.- Specified by:
colorBySequenceCluster
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
colorBySymmetry
Returns a Jmol script that colors subunits to highlight the symmetry within a structure Different subunits should have a consistent color scheme or different shade of the same colors- Specified by:
colorBySymmetry
in classJmolSymmetryScriptGenerator
- Returns:
- Jmol script
-
getMaxExtension
protected double getMaxExtension()Returns the maximum extension (length) of structure- Returns:
-