Set toggle - Revision history

Bell: 3 revisions

2014-03-28T03:53:17Z

3 revisions

Andrejoseph: /* Syntax */

2011-07-14T15:25:11Z

Syntax

Andrejoseph: /* Script */

2011-07-14T15:19:24Z

Script

Andrejoseph: Created page with "== Overview == Set_toggle binds a key to switch on and off a setting. == Syntax == set_toggle key, setting See Set_Key to find a list ..."

2011-07-14T12:08:10Z

Created page with "== Overview == Set_toggle binds a key to switch on and off a setting. == Syntax == <source lang="python"> set_toggle key, setting </source> See Set_Key to find a list ..."

New page

== Overview ==
[[Set_toggle]] binds a key to switch on and off a setting.

== Syntax ==
<source lang="python">
set_toggle key, setting
</source>

See [[Set_Key]] to find a list of key that can be redefined and [[Settings]] to find a list of settings.

== Examples ==
<source lang="python">
# Associates "F1" to grid_mode setting
set_toggle F1, grid_mode
</source>

== Script ==
<source lang="python">
# @AUTHOR: Joseph ANDRE
# Copyright (c) 2011, Joseph ANDRE
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
# conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this list of conditions and the following
# * disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
# * disclaimer in the documentation and/or other materials provided with the distribution.
# * Neither the name of the <ORGANIZATION> nor the names of its contributors may be used to endorse or promote products derived
# * from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
# NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
# THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# DATE : 2011-07-14
# REV : 1

from pymol import cmd
def toggle(setting=[]):
setting_value=cmd.get(setting)
if setting_value.isdigit():
if int(setting_value) == 1:
cmd.set(setting,"0")
else :
cmd.set(setting,"1")
elif setting_value.isalpha():
if setting_value == "on":
cmd.set(setting,"off")
else :
cmd.set(setting,"on")

def set_toggle(key, setting):
global sett
sett = [setting]
cmd.set_key(key, toggle, sett)

cmd.extend('set_toggle', set_toggle)
</source>

===See Also===

[[Set_Key ]]

[[Category:Script_Library|Set_toggle]]
[[Category:UI_Scripts]]

← Older revision	Revision as of 03:53, 28 March 2014
(No difference)

@@ Line 7: / Line 7: @@
 </source>
-See [[Set_Key]] to find a list of key that can be redefined and [[Settings]] to find a list of settings.
+See [[Set_Key]] to find a list of key that can be redefined and [[Settings]] to find a list of settings. You can also use auto-completion.
 == Examples ==

@@ Line 42: / Line 42: @@
 from pymol import cmd
 def toggle(setting=[]):
 	setting_value=cmd.get(setting)
-	if setting_value.isdigit():
+	if cmd.toggle_dict.get(setting_value, 0):
-		if int(setting_value) == 1:
+		cmd.unset(setting)
-			cmd.set(setting,"0")
+	else:
-		else :
+		cmd.set(setting)
 def set_toggle(key, setting):
-	global sett
+	cmd.set_key(key, toggle, [setting])
 cmd.extend('set_toggle', set_toggle)
 </source>