Set: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
=DESCRIPTION= | |||
[[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]]! | [[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= | |||
<source lang="python"> | <source lang="python"> | ||
# set '''name''' to '''value''' | # set '''name''' to '''value''' | ||
| Line 11: | Line 11: | ||
</source> | </source> | ||
=PYMOL API= | |||
<source lang="python"> | <source lang="python"> | ||
cmd.set ( string name, | cmd.set ( string name, | ||
| Line 21: | Line 21: | ||
</source> | </source> | ||
===NOTES | = EXAMPLES = | ||
<source lang="python"> | |||
set surface_color, red | |||
set ray_trace_mode, 3 | |||
set ribbon_width, 4 | |||
# set the label size to 2Ang. | |||
set label_size, -2 | |||
</source> | |||
=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. | 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. | If a selection is provided, then all objects in the selection will be affected. | ||
=SEE ALSO= | |||
[[Get]] | [[Get]] | ||
Revision as of 12:11, 20 May 2009
DESCRIPTION
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.