This is a read-only mirror of pymolwiki.org

Difference between revisions of "Set"

From PyMOL Wiki
Jump to navigation Jump to search
 
m (8 revisions)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===DESCRIPTION===
+
 
  "set" changes one of the PyMOL state variables,
+
[[set]] is one of the most utilized commands.  PyMOL representations, states, options, etc. are changed with '''set'''.  Briefly, [[set]] changes one of the PyMOL state variables.  Currently there are over ''600'' [[:Category:Settings|PyMOL settings]]!
+
 
===USAGE===
+
=USAGE=
  set name, [,value [,object-or-selection [,state ]]]
+
<source lang="python">
+
# set '''name''' to '''value'''
  set name = value  # (DEPRECATED)
+
set name, [,value [,object-or-selection [,state ]]]
+
 
===PYMOL API===
+
# alternative way to do the above.
 +
set name = value  # (DEPRECATED)
 +
</source>
 +
 
 +
=PYMOL API=
 +
<source lang="python">
 +
cmd.set ( string name,
 +
    string value=1,
 +
    string selection='',
 +
    int state=0,
 +
    int updates=1,
 +
    quiet=1)
 +
</source>
 +
 
 +
= EXAMPLES =
 
<source lang="python">
 
<source lang="python">
  cmd.set ( string name, string value=1,
+
set surface_color, red
            string selection='', int state=0,
+
 
              int updates=1, quiet=1)
+
set ray_trace_mode, 3
 +
 
 +
set ribbon_width, 4
 +
 
 +
# set the label size to 2Ang.
 +
set label_size, -2
 
</source>
 
</source>
===NOTES===
+
 
  The default behavior (with a blank selection) changes the global
+
=NOTES=
  settings database.  If the selection is 'all', then the settings
+
The default behavior (with a blank selection) changes the global settings database.  If the selection is 'all', then the settings database in all individual objects will be changed.  Likewise, for a given object, if state is zero, then the object database will be modified.  Otherwise, the settings database for the indicated state within the object will be modified.
  database in all individual objects will be changed.  Likewise, for
 
  a given object, if state is zero, then the object database will be
 
  modified.  Otherwise, the settings database for the indicated state
 
  within the object will be modified.
 
 
  If a selection is provided, then all objects in the selection will
 
  be affected.  
 
 
   
 
   
[[Category:Commands|set]]
+
If a selection is provided, then all objects in the selection will be affected.
 +
=SEE ALSO=
 +
[[Get]]
 +
 
 +
 
 +
[[Category:Commands|Set]]
 +
[[Category:Settings|Set]]
 +
[[Category:States|Set]]

Latest revision as of 03:49, 28 March 2014

set is one of the most utilized commands. PyMOL representations, states, options, etc. are changed with set. Briefly, set changes one of the PyMOL state variables. Currently there are over 600 PyMOL settings!

USAGE

# set '''name''' to '''value'''
set name, [,value [,object-or-selection [,state ]]]

# alternative way to do the above.
set name = value  # (DEPRECATED)

PYMOL API

cmd.set ( string name, 
    string value=1,
    string selection='',
    int state=0,
    int updates=1,
    quiet=1)

EXAMPLES

set surface_color, red

set ray_trace_mode, 3

set ribbon_width, 4

# set the label size to 2Ang.
set label_size, -2

NOTES

The default behavior (with a blank selection) changes the global settings database. If the selection is 'all', then the settings database in all individual objects will be changed. Likewise, for a given object, if state is zero, then the object database will be modified. Otherwise, the settings database for the indicated state within the object will be modified.

If a selection is provided, then all objects in the selection will be affected.

SEE ALSO

Get