Set Key - Revision history

Bell: 1 revision

2016-03-07T03:47:41Z

1 revision

Speleo3: updates

2016-03-07T01:39:05Z

updates

Bell: 8 revisions

2014-03-28T03:49:45Z

8 revisions

BorisKheyfets: /* PYTHON EXAMPLE */

2012-10-23T15:39:49Z

PYTHON EXAMPLE

Speleo3: make example working

2011-08-04T12:19:03Z

make example working

Slaw at 03:49, 25 May 2010

2010-05-25T03:49:00Z

New page

'''set_key''' binds a specific python function to a key press.

===PYMOL API (ONLY)===
<source lang="python">
cmd.set_key( string key, function fn, tuple arg=(), dict kw={})
</source>

===PYTHON EXAMPLE===
<source lang="python">
from pymol import cmd

def color_blue(object): cmd.color("blue",object)

cmd.set_key( 'F1' , make_it_blue, ( "object1" ) )
// would turn object1 blue when the F1 key is pressed and

cmd.set_key( 'F2' , make_it_blue, ( "object2" ) )
// would turn object2 blue when the F2 key is pressed.

cmd.set_key( 'CTRL-C' , cmd.zoom )
cmd.set_key( 'ALT-A' , cmd.turn, ('x',90) )
</source>

===KEYS WHICH CAN BE REDEFINED===
F1 to F12
left, right, pgup, pgdn, home, insert
CTRL-A to CTRL-Z
ALT-0 to ALT-9, ALT-A to ALT-Z

===SEE ALSO===
[[Button]] [[Check Key]]

[[Category:Commands|Set Key]]

Vinnyrose at 14:26, 20 June 2009

2009-06-20T14:26:19Z

New page

===DESCRIPTION===
'''set_key''' binds a specific python function to a key press.

===PYMOL API (ONLY)===
<source lang="python">
cmd.set_key( string key, function fn, tuple arg=(), dict kw={})
</source>

===PYTHON EXAMPLE===
<source lang="python">
from pymol import cmd

def color_blue(object): cmd.color("blue",object)

cmd.set_key( 'F1' , make_it_blue, ( "object1" ) )
// would turn object1 blue when the F1 key is pressed and

cmd.set_key( 'F2' , make_it_blue, ( "object2" ) )
// would turn object2 blue when the F2 key is pressed.

cmd.set_key( 'CTRL-C' , cmd.zoom )
cmd.set_key( 'ALT-A' , cmd.turn, ('x',90) )
</source>

===KEYS WHICH CAN BE REDEFINED===
F1 to F12
left, right, pgup, pgdn, home, insert
CTRL-A to CTRL-Z
ALT-0 to ALT-9, ALT-A to ALT-Z

===SEE ALSO===
[[Button]]

[[Category:Commands|Set Key]]

Tree at 04:54, 23 February 2005

2005-02-23T04:54:59Z

New page

===DESCRIPTION===

"set_key" binds a specific python function to a key press.

===PYMOL API (ONLY)===
<source lang="python">
cmd.set_key( string key, function fn, tuple arg=(), dict kw={})
</python?>

===PYTHON EXAMPLE===
<source lang="python">
from pymol import cmd

def color_blue(object): cmd.color("blue",object)

cmd.set_key( 'F1' , make_it_blue, ( "object1" ) )
// would turn object1 blue when the F1 key is pressed and

cmd.set_key( 'F2' , make_it_blue, ( "object2" ) )
// would turn object2 blue when the F2 key is pressed.

cmd.set_key( 'CTRL-C' , cmd.zoom )
cmd.set_key( 'ALT-A' , cmd.turn, ('x',90) )
</source>

===KEYS WHICH CAN BE REDEFINED===

F1 to F12
left, right, pgup, pgdn, home, insert
CTRL-A to CTRL-Z
ALT-0 to ALT-9, ALT-A to ALT-Z

===SEE ALSO===

[[Cmd button]]

[[Category:Commands|set_key]]

@@ Line 14: / Line 14: @@
 cmd.set_key( 'F1' , make_it_blue, [ "object1" ] )
 # would turn object1 blue when the F1 key is pressed and
 cmd.set_key( 'F2' , make_it_blue, [ "object2" ] )

← Older revision	Revision as of 03:47, 7 March 2016
(No difference)

@@ Line 1: / Line 1: @@
-'''set_key''' binds a specific python function to a key press.
+'''set_key''' binds a Python function or PyMOL command to a key press.
 <source lang="python">
-cmd.set_key( string key, function fn, tuple arg=(), dict kw={})
+cmd.set_key(string key, function fn, tuple arg=(), dict kw={})
 </source>
-===PYTHON EXAMPLE===
+''Also supported since PyMOL 1.7:''
 <source lang="python">
 from pymol import cmd
-def make_it_blue(object): cmd.color("blue",object)
+# define a custom function which colors a selection blue
 cmd.set_key( 'F1' , make_it_blue, [ "object1" ] )
-# would turn object1 blue when the F1 key is pressed and
+</source>
-# (in order to use it one has to make a selection called
-# object1)
+<source lang="python">
+# zoom on everything
 cmd.set_key( 'CTRL-C' , cmd.zoom )
 cmd.set_key( 'ALT-A' , cmd.turn, ('x',90) )
 </source>
-===KEYS WHICH CAN BE REDEFINED===
+ # zoom on first ligand when pressing F1 (PyMOL 1.7+)
   F1 to F12
   left, right, pgup, pgdn, home, insert
@@ Line 30: / Line 70: @@
   ALT-0 to ALT-9, ALT-A to ALT-Z
-===SEE ALSO===
+== See Also ==
 [[Button]] [[Check Key]]
 [[Category:Commands|Set Key]]

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

@@ Line 10: / Line 10: @@
 from pymol import cmd
-def color_blue(object): cmd.color("blue",object)
+def make_it_blue(object): cmd.color("blue",object)
-cmd.set_key( 'F1' , make_it_blue, ( "object1" ) )
+cmd.set_key( 'F1' , make_it_blue, [ "object1" ] )
-// would turn object1 blue when the F1 key is pressed and
+# would turn object1 blue when the F1 key is pressed and
-cmd.set_key( 'F2' , make_it_blue, ( "object2" ) )
+cmd.set_key( 'F2' , make_it_blue, [ "object2" ] )
-// would turn object2 blue when the F2 key is pressed.
+# would turn object2 blue when the F2 key is pressed.
 cmd.set_key( 'CTRL-C' , cmd.zoom )