Scene

From PyMOLWiki
Revision as of 00:46, 23 February 2005 by Tree (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

DESCRIPTION

  "scene" makes it possible to save and restore multiple scenes scene
  within a single session.  A scene consists of the view, all object
  activity information, all atom-wise visibility, color,
  representations, and the global frame index.  

USAGE

  scene key [,action [,message [ ,view [,color [,active [,rep [,frame]]]]]]]
  scene *

  key can be any string
  action should be 'store' or 'recall' (default: 'recall')

  view: 1 or 0 controls whether the view is stored
  color: 1 or 0 controls whether colors are stored
  active: 1 or 0 controls whether activity is stored
  rep: 1 or 0 controls whether the representations are stored
  frame: 1 or 0 controls whether the frame is stored
  

PYMOL API

   cmd.scene(string key,string action,string-or-list message,int view,
             int color, int active, int rep, int frame)

EXAMPLES

  scene F1, store
  scene F2, store, This view shows you the critical hydrogen bond.

  scene F1
  scene F2

NOTES

  Scenes F1 through F12 are automatically bound to function keys
  provided that "set_key" hasn't been used to redefine the behaviour
  of the respective key.
  

SEE ALSO

  Cmd view, Cmd set_view, Cmd get_view

DEVELOPMENT TO DO

  Add support for save/restore of a certain global and
     object-and-state specific settings, such as: state,
     surface_color, ribbon_color, stick_color, transparency,
     sphere_transparency, etc.  This would probably best be done by
     defining a class of "scene" settings which are treated in this
     manner.  The current workaround is to create separate objects
     which are enabled/disabled differentially.