/usr/lib/python2.7/dist-packages/pymol/controlling.py is in pymol 1.8.4.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 | #A* -------------------------------------------------------------------
#B* This file contains source code for the PyMOL computer program
#C* Copyright (c) Schrodinger, LLC.
#D* -------------------------------------------------------------------
#E* It is unlawful to modify or remove this copyright notice.
#F* -------------------------------------------------------------------
#G* Please see the accompanying LICENSE file for further information.
#H* -------------------------------------------------------------------
#I* Additional authors of this source file include:
#-*
#-*
#-*
#Z* -------------------------------------------------------------------
from __future__ import print_function
if __name__=='pymol.controlling' or __name__=='controlling':
try:
from . import selector, internal
from .shortcut import Shortcut
cmd = __import__("sys").modules["pymol.cmd"]
from .cmd import _cmd, QuietException, is_string, \
boolean_dict, boolean_sc, \
DEFAULT_ERROR, DEFAULT_SUCCESS, is_ok, is_error, \
location_code, location_sc
import pymol
except:
from shortcut import Shortcut
cmd = None
button_code = {
'left' : 0,
'middle' : 1,
'right' : 2,
'wheel' : 3,
'double_left' : 4,
'double_middle' : 5,
'double_right' : 6,
'single_left' : 7,
'single_middle' : 8,
'single_right' : 9
}
button_sc = Shortcut(button_code.keys())
but_mod_code = {
'none' : 0,
'shft' : 1,
'ctrl' : 2,
'ctsh' : 3,
'alt' : 4,
'alsh' : 5,
'ctal' : 6,
'ctas' : 7,
}
but_mod_sc = Shortcut(but_mod_code.keys())
but_act_code = {
'rota' : 0 ,
'move' : 1 ,
'movz' : 2 ,
'clip' : 3 ,
'rotz' : 4 ,
'clpn' : 5 ,
'clpf' : 6 ,
'lb' : 7 ,
'mb' : 8 ,
'rb' : 9 ,
'+lb' : 10 ,
'+mb' : 11 ,
'+rb' : 12 ,
'pkat' : 13 ,
'pkbd' : 14 ,
'rotf' : 15 ,
'torf' : 16 ,
'movf' : 17 ,
'orig' : 18 ,
'+lbx' : 19 ,
'-lbx' : 20 ,
'lbbx' : 21 ,
'none' : 22 ,
'cent' : 23 ,
'pktb' : 24 ,
'slab' : 25 ,
'movs' : 26 ,
'pk1' : 27 ,
'mova' : 28 ,
'menu' : 29 ,
'sele' : 30 ,
'+/-' : 31 ,
'+box' : 32 ,
'-box' : 33 ,
'mvsz' : 34 ,
'dgrt' : 36 ,
'dgmv' : 37 ,
'dgmz' : 38 ,
'roto' : 39 ,
'movo' : 40 ,
'mvoz' : 41 ,
'mvfz' : 42 ,
'mvaz' : 43 ,
'drgm' : 44 ,
'rotv' : 45 ,
'movv' : 46 ,
'mvvz' : 47 ,
# 48 for internal use only
'drgo' : 49 ,
'imsz' : 50 ,
'imvz' : 51 ,
'box' : 52 ,
'irtz' : 53 ,
'rotl' : 54 ,
'movl' : 55 ,
'mvzl' : 56
}
but_act_sc = Shortcut(but_act_code.keys())
ring_dict = {
'maestro' : [ 'three_button_maestro' ],
'three_button' : [ 'three_button_viewing',
'three_button_editing',
], # LEGACY
'three_button_viewing' : [ 'three_button_viewing',
'three_button_editing',
],
'three_button_editing' : [ 'three_button_editing',
'three_button_viewing',
],
'two_button' : [ 'two_button_viewing', # LEGACY
'two_button_selecting',
],
'two_button_viewing' : [ 'two_button_viewing',
'two_button_selecting',
],
'two_button_editing' : [ 'two_button_editing',
'two_button_viewing',
'two_button_selecting',
],
'three_button_motions' : [ 'three_button_motions',
'three_button_viewing', ],
'three_button_all_modes' : [ 'three_button_editing',
'three_button_motions',
'three_button_viewing',
'three_button_lights', ],
'one_button' : [ 'one_button_viewing' ],
}
ring_dict_sc = Shortcut(ring_dict.keys())
def config_mouse(ring='three_button', quiet=1, _self=cmd):
'''
DESCRIPTION
"config_mouse" sets the current mouse configuration ring.
USAGE
config_mouse ring
EXAMPLES
config_mouse three_button
config_mouse two_button
config_mouse one_button
PYMOL API
cmd.config_mouse(string ring, int quiet)
SEE ALSO
mouse, button
'''
global mouse_ring
ring=ring_dict_sc.auto_err(ring,'mouse cycle')
if ring in ring_dict:
_self.set("button_mode",0);
mouse_ring = ring_dict[ring]
if not quiet:
print(" config_mouse: %s"%ring)
_self.mouse(quiet=1,_self=_self)
else:
print(" Error: unrecognized mouse ring: '%s'"%ring)
mouse_ring = ring_dict['three_button']
mode_name_dict = {
'three_button_lights' : '3-Button Lights',
'three_button_maestro' : '3-Button Maestro',
'three_button_viewing' : '3-Button Viewing',
'three_button_editing' : '3-Button Editing',
'three_button_motions' : '3-Button Motions',
'two_button_viewing' : '2-Button Viewing',
'two_button_selecting' : '2-Btn. Selecting',
'two_button_editing' : '2-Button Editing',
'two_button_lights' : '2-Button Lights',
'one_button_viewing' : '1-Button Viewing',
}
mode_name_list = [
'three_button_lights' ,
'three_button_viewing',
'three_button_editing',
'three_button_motions',
'three_button_maestro' ,
'two_button_viewing' ,
'two_button_selecting' ,
'two_button_editing',
'two_button_lights',
'one_button_viewing' ,
'default' ,
# okay to append new mode name, but don't insert: order & position matter
]
mode_dict = {
'three_button_lights' :
[ ('l','none','rota'),
('m','none','move'),
('r','none','movz'),
('l','shft','rotl'),
('m','shft','movl'),
('r','shft','mvzl') ,
('l','ctrl','none'),
('m','ctrl','none'),
('r','ctrl','none'),
('l','ctsh','none'),
('m','ctsh','none'),
('r','ctsh','none'),
('l','alt' ,'none'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','slab'),
('w','shft','movs'),
('w','ctrl','mvsz'),
('w','ctsh','movz'),
('double_left','none','none'),
('double_middle','none','none'),
('double_right','none', 'none'),
('single_left','none','none'),
('single_middle','none','cent'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'two_button_lights' :
[ ('l','none','rota'),
('m','none','none'),
('r','none','movz'),
('l','shft','rotl'),
('m','shft','none'),
('r','shft','mvzl'),
('l','ctrl','movl'),
('m','ctrl','none'),
('r','ctrl','none'),
('l','ctsh','none'),
('m','ctsh','none'),
('r','ctsh','cent'),
('l','alt' ,'none'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','none'),
('w','shft','none'),
('w','ctrl','none'),
('w','ctsh','none'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none','cent'),
('single_left','none','none'),
('single_middle','none','none'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'three_button_maestro' :
[ ('l','none','box'),
('m','none','rota'),
('r','none','move'),
('l','shft','+Box'),
('m','shft','-Box'),
('r','shft','clip'),
('l','ctrl','+/-'),
('m','ctrl','irtz'),
('r','ctrl','pk1'),
('l','ctsh','Sele'),
('m','ctsh','orig'),
('r','ctsh','clip'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','imvz'),
('w','shft','movs'),
('w','ctrl','none'), # disable since ctrl-middle is irtz
('w','ctsh','slab'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none', 'pkat'),
('single_left','none','sele'),
('single_middle','none','cent'),
('single_right','none', 'menu'),
('single_left','shft','+/-'),
('single_left','alt', 'cent'),
],
'three_button_viewing' :
[ ('l','none','rota'),
('m','none','move'),
('r','none','movz'),
('l','shft','+Box'),
('m','shft','-Box'),
('r','shft','clip'),
('l','ctrl','+/-'),
('m','ctrl','pkat'),
('r','ctrl','pk1'),
('l','ctsh','Sele'),
('m','ctsh','orig'),
('r','ctsh','clip'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','slab'),
('w','shft','movs'),
('w','ctrl','mvsz'),
('w','ctsh','movz'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none', 'pkat'),
('single_left','none','+/-'),
('single_middle','none','cent'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'three_button_editing':
[ ('l','none','rota'),
('m','none','move'),
('r','none','movz'),
('l','shft','roto'),
('m','shft','movo'),
('r','shft','mvoz') ,
('l','ctrl','torf'),
('m','ctrl','+/-'),
('r','ctrl','pktb'),
('l','ctsh','mova'),
('m','ctsh','orig'),
('r','ctsh','clip'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','slab'),
('w','shft','movs'),
('w','ctrl','mvsz'),
('w','ctsh','movz'),
('double_left','none','torf'),
('double_middle','none','drgm'),
('double_right','none', 'pktb'),
('single_left','none','pkat'),
('single_middle','none','cent'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'three_button_motions':
[ ('l','none','rota'),
('m','none','move'),
('r','none','movz'),
('l','shft','rotv'),
('m','shft','movv'),
('r','shft','mvvz') ,
('l','ctrl','torf'),
('m','ctrl','pkat'),
('r','ctrl','pktb'),
('l','ctsh','mova'),
('m','ctsh','orig'),
('r','ctsh','clip'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','slab'),
('w','shft','movs'),
('w','ctrl','mvsz'),
('w','ctsh','movz'),
('double_left','none','menu'),
('double_left','none','torf'),
('double_middle','none','drgm'),
('double_right','none', 'pktb'),
('single_left','none','pkat'),
('single_middle','none','cent'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'two_button_viewing' :
[ ('l','none','rota'),
('m','none','none'),
('r','none','movz'),
('l','shft','pk1'),
('m','shft','none'),
('r','shft','clip'),
('l','ctrl','move'),
('m','ctrl','none'),
('r','ctrl','pkat'),
('l','ctsh','sele'),
('m','ctsh','none'),
('r','ctsh','cent'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','none'),
('w','shft','none'),
('w','ctrl','none'),
('w','ctsh','none'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none','cent'),
('single_left','none','pkat'),
('single_middle','none','none'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'two_button_selecting' :
[ ('l','none','rota'),
('m','none','none'),
('r','none','movz'),
('l','shft','+Box'),
('m','shft','none'),
('r','shft','-Box'),
('l','ctrl','+/-'),
('m','ctrl','none'),
('r','ctrl','pkat'),
('l','ctsh','sele'),
('m','ctsh','none'),
('r','ctsh','cent'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','none'),
('w','shft','none'),
('w','ctrl','none'),
('w','ctsh','none'),
('double_left','none','menu'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none','cent'),
('single_left','none','+/-'),
('single_right','none', 'menu'),
('single_left','alt', 'cent'),
],
'two_button_editing' :
[ ('l','none','rota'),
('m','none','none'),
('r','none','movz'),
('l','shft','pkat'),
('m','shft','none'),
('r','shft','clip'),
('l','ctrl','torf'),
('m','ctrl','none'),
('r','ctrl','pktb'),
('l','ctsh','rotf'),
('m','ctsh','none'),
('r','ctsh','movf'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('w','none','none'),
('w','shft','none'),
('w','ctrl','none'),
('w','ctsh','none'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none','cent'),
('single_left','none','pkat'),
('single_middle','none','none'),
('single_right','none','menu'),
('single_left','alt', 'cent'),
],
'one_button_viewing' :
[ ('l','none','rota'), # approximate the old GLUT behavior on Mac
('m','none','none'),
('r','none','none'),
('l','shft','+Box'),
('m','shft','none'),
('r','shft','none'),
('l','ctrl','movZ'),
('m','ctrl','none'),
('r','ctrl','none'),
('l','ctsh','clip'),
('m','ctsh','none'),
('r','ctsh','none'),
('l','alt' ,'move'),
('m','alt' ,'none'),
('r','alt' ,'none'),
('l','alsh' ,'-Box'),
('m','alsh' ,'none'),
('r','alsh' ,'none'),
('l','ctal' ,'none'),
('m','ctal' ,'none'),
('r','ctal' ,'none'),
('l','ctas' ,'none'),
('m','ctas' ,'none'),
('r','ctas' ,'none'),
('w','none','slab'),
('w','shft','movs'),
('w','ctrl','mvsz'),
('w','ctsh','movz'),
('double_left','none','menu'),
('double_middle','none','none'),
('double_right','none', 'none'),
('single_left','none','+/-'),
('single_middle','none','none'),
('single_right','none', 'none'),
('single_left','shft','none'),
('single_left','ctrl','menu'),
('single_left','ctsh','pkat'),
('single_left','alt', 'cent'),
('single_left','alsh','none'),
('single_left','ctal','none'),
('single_left','ctas','none'),
],
'default' :
[ ('l','none','rota'), # default that is set in PyMOL.c PyMOL_SetDefaultMouse
('m','none','move'),
('r','none','movz'),
('r','shft','clip'),
('m','ctsh','orig'),
('w','none','slab'),
('w','shft','movs'),
('w','ctrl','mvsz'),
('w','ctsh','movz'),
('double_middle','none','none'),
('single_middle','none','cent')
]
}
def find(name, i=0, quiet=1, _self=cmd):
'''
DESCRIPTION
Find an item in the object menu panel and scroll it to the top.
'''
raise pymol.IncentiveOnlyException()
def order(names,sort=0,location='current',_self=cmd):
'''
DESCRIPTION
"order" changes the ordering of names in the control panel.
USAGE
order names, sort, location
ARGUMENTS
names = string: a space-separated list of names
sort = yes or no {default: no}
location = top, current, or bottom {default: current}
EXAMPLES
order 1dn2 1fgh 1rnd # sets the order of these three objects
order *,yes # sorts all names
order 1dn2_*, yes # sorts all names beginning with 1dn2_
order 1frg, location=top # puts 1frg at the top of the list
PYMOL API
cmd.order(string names, string sort, string location)
NOTES
"order" can also be used to reorder objects within a group.
SEE ALSO
set_name, group
'''
r = DEFAULT_ERROR
location=location_code[location_sc.auto_err(location,'location')]
if is_string(sort):
sort=boolean_dict[boolean_sc.auto_err(sort,'sort option')]
try:
_self.lock(_self)
r = _cmd.order(_self._COb,str(names),int(sort),int(location))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise pymol.CmdException
return r
def mouse(action=None, quiet=1, _self=cmd):# INTERNAL
'''
DESCRIPTION
"mouse" cycles through the mouse modes defined in the current
mouse configuration ring.
USAGE
mouse
'''
# NOTE: PyMOL automatically runs this routine upon start-up
r = DEFAULT_ERROR
try:
_self.lock(_self)
if action=='forward':
bm = _self.get_setting_int("button_mode")
bm = (int(bm) + 1) % len(mouse_ring)
_self.set("button_mode",str(bm),quiet=1)
action=None
elif action=='backward':
bm = _self.get_setting_int("button_mode")
bm = (int(bm) - 1) % len(mouse_ring)
_self.set("button_mode",str(bm),quiet=1)
action=None
elif action=='select_forward':
sm = _self.get_setting_int("mouse_selection_mode")
sm = sm + 1
if sm>6: sm = 0
_self.set("mouse_selection_mode",sm,quiet=1)
elif action=='select_backward':
sm = _self.get_setting_int("mouse_selection_mode")
sm = sm - 1
if sm<0: sm = 6
_self.set("mouse_selection_mode",sm,quiet=1)
mode_list = None
if action==None:
bm = _self.get_setting_int("button_mode")
if bm>=0:
bm = bm % len(mouse_ring)
mode = mouse_ring[bm]
_self.set("button_mode_name",mode_name_dict.get(mode,mode))
mode_list = mode_dict[mode]
else:
bm = (-1-bm) % len(mode_name_list)
mode = mode_name_list[bm]
_self.set("button_mode_name",mode_name_dict.get(mode,mode))
mode_list = mode_dict[mode]
elif action in mouse_ring:
mode = action
_self.set("button_mode_name",mode_name_dict.get(mode,mode))
bm = mouse_ring.index(mode)
_self.set("button_mode",bm)
mode_list = mode_dict[mode]
elif action in mode_dict:
mode = action
_self.set("button_mode_name",mode_name_dict.get(mode,mode))
bm = -1 - mode_name_list.index(action)
_self.set("button_mode",bm)
mode_list = mode_dict[mode]
if mode_list!=None:
kw_dict = {'_self':_self}
for a in mode_list:
button(*a, **kw_dict)
if not quiet:
print(" mouse: %s"%mode)
if mode[-7:]!='editing': _self.unpick()
if mode[-7:]=='editing': _self.deselect()
r = DEFAULT_SUCCESS
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise pymol.CmdException
return r
def edit_mode(active=1,quiet=1,_self=cmd):
'''
DESCRIPTION
"edit_mode" switches the mouse into editing mode, if such a mode
is available in the current mouse ring.
'''
# legacy function
if is_string(active):
active=boolean_dict[boolean_sc.auto_err(active,'active')]
active = int(active)
bm = _self.get_setting_int("button_mode")
if 0 <= bm < len(mouse_ring):
mouse_mode = mouse_ring[bm]
if active:
if mouse_mode[0:10]=='two_button':
if mouse_mode!='two_button_editing':
mouse(action='two_button_editing',quiet=quiet,_self=_self)
elif mouse_mode[0:12] == 'three_button':
if mouse_mode!='three_button_editing':
mouse(action='three_button_editing',quiet=quiet,_self=_self)
else:
if mouse_mode[0:10]=='two_button':
if mouse_mode!='two_button_viewing':
mouse(action='two_button_viewing',quiet=quiet,_self=_self)
elif mouse_mode[0:12] == 'three_button':
if mouse_mode!='three_button_viewing':
mouse(action='three_button_viewing',quiet=quiet,_self=_self)
return DEFAULT_SUCCESS
def set_key(key,fn=None,arg=(),kw={},_self=cmd):
'''
DESCRIPTION
"set_key" binds a specific python function to a key press.
New in PyMOL 1.6.1: second argument can also be a string in PyMOL
command syntax.
USAGE
set_key key, command
EXAMPLE
set_key F1, as cartoon, polymer; as sticks, organic
PYMOL API (ONLY)
cmd.set_key( string key, function fn, tuple arg=(), dict kw={})
PYTHON EXAMPLE
from pymol import cmd
def color_blue(object): cmd.color("blue",object)
cmd.set_key( 'F1' , color_blue, ( "object1" ) )
// would turn object1 blue when the F1 key is pressed and
cmd.set_key( 'F2' , color_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) )
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, alias
'''
if fn is None:
def decorator(func):
set_key(key, func, arg, kw, _self)
return func
return decorator
if is_string(fn):
if arg or kw:
raise ValueError('arg and kw must be empty if fn is string')
else:
fn = (fn, arg, kw)
mod, _, pat = key.rpartition('-')
if mod not in internal.modifier_keys:
raise pymol.CmdException("not a valid modifier key: '%s'." % mod)
if len(pat) > 1:
if pat[0] != 'F':
pat = pat.lower()
key = pat if not mod else (mod + '-' + pat)
if pat not in internal.special_key_names:
raise pymol.CmdException("special '%s' key not found." % pat)
elif not mod:
raise pymol.CmdException("Can't map regular letters.")
elif mod == 'SHFT':
raise pymol.CmdException("Can't map regular letters with SHFT.")
_self.key_mappings[key] = fn
return DEFAULT_SUCCESS
def button(button, modifier, action, _self=cmd):
'''
DESCRIPTION
"button" can be used to redefine what the mouse buttons do.
USAGE
button button, modifier, action
ARGUMENTS
button = left, middle, right, wheel, double_left, double_middle,
double_right, single_left, single_middle, or single_right
modifiers = None, Shft, Ctrl, CtSh, CtAl, CtAl, CtAS,
actions = None, Rota, Move, MovZ, Slab, +Box, -Box, Clip, MovS,
+/-, PkAt, Pk1, MvSZ, Sele, Orig, Menu, PkAt, Pk1 RotO, MovO,
MvOZ, MovA, PkAt, PkTB, MvSZ MvAZ, DrgM, RotZ, PkBd, ClpN,
ClpF
NOTES
Changes made using the button command are easily overridden when
the user iterates through the mouse modes. This behavior needs to
be changed.
Obsolete actions: lb, mb, rb, +lb, +mb, +rb, +lbX, -lbX,
Unsupported, Internal, or Future Actions: RotD, MovD, MvDZ, RotF,
MovF, MvFZ, TorF, RotV, MovV, MvVZ, DgMZ, DgRT
PYMOL API
cmd.button(string button, string modifier, string action)
SEE ALSO
config_mouse
'''
r = DEFAULT_ERROR
try:
_self.lock(_self)
button = button.lower()
button = button_sc.auto_err(button,'button')
modifier = modifier.lower()
modifier = but_mod_sc.auto_err(modifier,'modifier')
action = action.lower()
action = but_act_sc.auto_err(action,'action')
button_num = button_code[button]
but_mod_num = but_mod_code[modifier]
if button_num<3: # normal button (L,M,R)
if but_mod_num < 4: # none, shft, ctrl, ctsh
but_code = button_num + 3*but_mod_num
else: # alt, alsh, alct, alcs
but_code = button_num + 68 + 3*(but_mod_num-4)
elif button_num < 4: # wheel
if but_mod_num < 4: # none, shft, ctrl, ctsh
but_code = 12 + but_mod_num
else:
but_code = 64 + but_mod_num - 4
else: # single and double clicks
but_code = (16 + button_num - 4) + but_mod_num * 6
act_code = but_act_code[action]
r = _cmd.button(_self._COb,but_code,act_code)
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise pymol.CmdException
return r
def mask(selection="(all)",quiet=1,_self=cmd):
'''
DESCRIPTION
"mask" makes it impossible to select the indicated atoms using the
mouse. This is useful when you are working with one molecule in
front of another and wish to avoid accidentally selecting atoms in
the background.
USAGE
mask (selection)
PYMOL API
cmd.mask( string selection="(all)" )
SEE ALSO
unmask, protect, deprotect, mouse
'''
r = DEFAULT_ERROR
# preprocess selection
selection = selector.process(selection)
#
try:
_self.lock(_self)
r = _cmd.mask(_self._COb,"("+str(selection)+")",1,int(quiet))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise pymol.CmdException
return r
def unmask(selection="(all)",quiet=1,_self=cmd):
'''
DESCRIPTION
"unmask" reverses the effect of "mask" on the indicated atoms.
PYMOL API
cmd.unmask( string selection="(all)" )
USAGE
unmask (selection)
SEE ALSO
mask, protect, deprotect, mouse
'''
r = DEFAULT_ERROR
# preprocess selection
selection = selector.process(selection)
#
try:
_self.lock(_self)
r = _cmd.mask(_self._COb,"("+str(selection)+")",0,int(quiet))
finally:
_self.unlock(r,_self)
if _self._raising(r,_self): raise pymol.CmdException
return r
|