Set toggle

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 of key that can be redefined and Settings to find a list of settings. You can also use auto-completion.

Examples

# Associates "F1" to grid_mode setting
set_toggle F1, grid_mode

Script

# @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 cmd.toggle_dict.get(setting_value, 0):
		cmd.unset(setting)
	else:
		cmd.set(setting)

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

cmd.auto_arg[1].update({
   'set_toggle'         : cmd.auto_arg[0]['set'],
})
	
cmd.extend('set_toggle', set_toggle)

See Also

Set_Key