This is a read-only mirror of pymolwiki.org
Difference between revisions of "Set"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
===DESCRIPTION=== | ===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]]! | |
| − | + | ||
===USAGE=== | ===USAGE=== | ||
| − | + | <source lang="python"> | |
| − | + | # set '''name''' to '''value''' | |
| − | + | set name, [,value [,object-or-selection [,state ]]] | |
| − | + | ||
| + | # alternative way to do the above. | ||
| + | set name = value # (DEPRECATED) | ||
| + | </source> | ||
| + | |||
===PYMOL API=== | ===PYMOL API=== | ||
<source lang="python"> | <source lang="python"> | ||
| − | + | cmd.set ( string name, | |
| − | + | string value=1, | |
| − | + | string selection='', | |
| + | int state=0, | ||
| + | int updates=1, | ||
| + | quiet=1) | ||
</source> | </source> | ||
| + | |||
===NOTES=== | ===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]] | ||
| + | |||
| + | |||
[[Category:Commands|set]] | [[Category:Commands|set]] | ||
| + | [[Category:Settings]] | ||
| + | [[Category:States]] | ||
Revision as of 16:15, 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)
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.