Logo Search packages:      
Sourcecode: pymol version File versions  Download package

setting.py

#A* -------------------------------------------------------------------
#B* This file contains source code for the PyMOL computer program
#C* copyright 1998-2000 by Warren Lyford Delano of DeLano Scientific. 
#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* -------------------------------------------------------------------

if __name__=='pymol.setting':
    
    import traceback
    import string
    import types
    import selector
    from shortcut import Shortcut
    import cmd
    from cmd import _cmd,lock,lock_attempt,unlock,QuietException, \
          _feedback,fb_module,fb_mask, \
          DEFAULT_ERROR, DEFAULT_SUCCESS, _raising, is_ok, is_error        
    from cmd import is_string
    import re
    
    boolean_type = 1
    int_type     = 2
    float_type   = 3
    float3_type  = 4

    class SettingIndex: # number, description, range, notes
        bonding_vdw_cutoff    =(0,'is not used')
        min_mesh_spacing      =(1,'determines the minimum spacing of the mesh representation, in Angstroms.')
        dot_density           =(2,'determines the density of the dot representation', '0 to 4' )
        dot_mode              =(3,'is not used (yet)')
        solvent_radius        =(4,'is the radius of solvent probe used in various surface calculations','1.0 to 2.0')
        sel_counter           =(5,'keeps track of how many automatic (unnamed) selections have been created')
        bg_rgb                =(6,'is the RGB triplet for the background color','[0,0,0] to [1,1,1]')
        ambient               =(7,'is the amount of ambient light present', '0 to 0.5', 'only applies to ray-traced images')
        direct                =(8,'is the amount of directed light emitted from the camera', '0 to 1')
        reflect               =(9,'is the amount of reflected light emitted from the movable light source', '0 to 1')
        light                =(10,'is the direction of the movable light source')
        power                =(11,'is an exponent used in calculating the direct light','0 to 2')
        antialias            =(12,'controls the extent of antialiasing applied by the ray tracer','0 to 4')
        cavity_cull          =(13,'set the maximum size (in points) for cavity elimination by the surfacing algorithm','0 or greater')
        gl_ambient           =(14,'ambient light setting for OpenGL')
        single_image         =(15,'has unknown unknown')
        movie_delay          =(16,'controls how long PyMOL will pause between frames when playing movies','0 or greater')
        ribbon_power         =(17,'is an exponent parameter for ribbon generation')
        ribbon_power_b       =(18,'is an exponent parameter for ribbon generation')
        ribbon_sampling      =(19,'controls how many interpolation segments are used in the ribbon representation')
        ribbon_radius        =(20,'controls the ribbon radius when ray tracing (subordinate to ribbon_width)')
        stick_radius         =(21,'controls the stick radius when ray tracing')
        hash_max             =(22,'controls the maximum dimension of the 3D hash table used by the ray tracer')
        orthoscopic          =(23,'controls whether the OpenGL window is perspective or orthoscopic')
        spec_reflect         =(24,'controls the specular intensity of the reflected light')
        spec_power           =(25,'is an exponent parameter for specular reflections')
        sweep_angle          =(26,'controls how wide an angle is swept out by the rocking function')
        sweep_speed          =(27,'controls the rate of the rocking function')
        dot_hydrogens        =(28,'controls whether or not hydrogens are included in the dot representation')
        dot_radius           =(29,'controls the dot radius when ray tracing (subordinate to dot_radius)')
        ray_trace_frames     =(30,'controls whether or not each frame is automatically passed off to the ray tracer')
        cache_frames         =(31,'controls whether or not each frame is stored in RAM')
        trim_dots            =(32,'controls whether or not dot representations are trimmed by the exclude and ignore flags')
        cull_spheres         =(33,'controls whether or not hidden triangles in surfaces are automatically removed')
        test1                =(34,'is for use during development')
        test2                =(35,'is for use during development')
        surface_best         =(36,'is a triangle separation parameter for high quality surfaces')
        surface_normal       =(37,'is a triangle separation parameter for normal quality surfaces')
        surface_quality      =(38,'controls the quality of the surface','-2 to 4')
        surface_proximity    =(39,'controls whether or not shared triangles are drawn for hidden and visible atoms')
        normal_workaround    =(40,'may no longer be necessary')
        stereo_angle         =(41,'is a secondary input parameter for controlling the stereo effect')
        stereo_shift         =(42,'is the primary input parameter for controlling the stereo effect')
        line_smooth          =(43,'controls whether or not OpenGL lines are antialiased to reduce pixelation')
        line_width           =(44,'controls the thickness of line representation (in screen pixels)')
        half_bonds           =(45,'controls whether or not half-bonds are drawn between hidden and visible atoms')
        stick_quality        =(46,'controls how many segments are used in drawing cylinders for sticks')
        stick_overlap        =(47,'affects how well sticks appear to fit together at the joints')
        stick_nub            =(48,'controls the height of the cone at the end of the sticks')
        all_states           =(49,'controls whether all states are shown at once in PyMOL')
        pickable             =(50,'controls whether or not atoms can be picked and selected with the mouse')
        auto_show_lines      =(51,'controls whether or not lines are automatically displayed in new objects')
        idle_delay           =(52,'controls how long PyMOL before PyMOL beings idling')
        no_idle              =(53,'controls whether or not PyMOL will do in to idling mode')
        fast_idle            =(54,'controls how long PyMOL sleeps when on fast idle')
        slow_idle            =(55,'controls how long PyMOL sleeps when on slow idle')
        rock_delay           =(56,'controls how frequently the screen is updated when rockinig')
        dist_counter         =(57,'keeps track of how many distance objects have been created')
        dash_length          =(58,'controls the length of dashes')
        dash_gap             =(59,'controls the length of gaps between dashes')
        auto_zoom            =(60,'controls whether or not new objects are automatically zoomed')
        overlay              =(61,'controls whether or not text output is overlayed on the graphics')
        text                 =(62,'controls whether text output is visible in the PyMOL window')
        button_mode          =(63,'is not functioning correctly')
        valence              =(64,'controls whether or not bond valences are visible with lines and sticks')
        nonbonded_size       =(65,'determines the size of the nonbonded representations')
        label_color          =(66,'overrides atomic label colors')
        ray_trace_fog        =(67,'controls depth cue fogging during ray tracing (subordinate to depth_cue)')
        spheroid_scale       =(68,'is unsupported functionality')
        ray_trace_fog_start  =(69,'controls where fogs starts when ray tracing')
        spheroid_smooth      =(70,'is unsupported functionality')
        spheroid_fill        =(71,'is unsupported functionality')
        auto_show_nonbonded  =(72,'controls whether or not nonbonded atoms are automatically display in new objects')
        cache_display        =(73,'controls whether or not the display is cached underneath the popup menus')
        mesh_radius          =(74,'controls mesh thicking when ray tracing (subordinate to mesh_width)')
        backface_cull        =(75,'controls whether or not backward facing triangles are not filtered out when ray tracing')
        gamma                =(76,'is the gamma function parameter applied during ray tracing')
        dot_width            =(77,'controls the width of dots (in screen pixels)')
        auto_show_selections =(78,'controls whether or not selections are automatically enabled when they are created')
        auto_hide_selections =(79,'controls whether or not selections are automatically hidden at various times')
        selection_width      =(80,'controls the minimum width of selection indicators in pixels')
        selection_overlay    =(81,'controls whether selection indicators are overlayed on the image or drawn using z-buffer clipping')
        static_singletons    =(82,'')
        max_triangles        =(83,'','')
        depth_cue            =(84,'','')
        specular             =(85,'','')
        shininess            =(86,'','')
        sphere_quality       =(87,'','')
        fog                  =(88,'','')
        isomesh_auto_state   =(89,'','')
        mesh_width           =(90,'','')
        cartoon_sampling     =(91,'','')
        cartoon_loop_radius  =(92,'','')
        cartoon_loop_quality =(93,'','')
        cartoon_power        =(94,'','')
        cartoon_power_b      =(95,'','')
        cartoon_rect_length  =(96,'','')
        cartoon_rect_width   =(97,'','')
        internal_gui_width   =(98,'','')
        internal_gui         =(99,'','')
        cartoon_oval_length  =(100,'','')
        cartoon_oval_width   =(101,'','')
        cartoon_oval_quality =(102,'','')
        cartoon_tube_radius  =(103,'','')
        cartoon_tube_quality =(104,'','')
        cartoon_debug        =(105,'','')
        ribbon_width         =(106,'','')
        dash_width           =(107,'','')
        dash_radius          =(108,'','')
        cgo_ray_width_scale  =(109,'','')
        line_radius          =(110,'','')
        cartoon_round_helices     =(111,'','')
        cartoon_refine_normals    =(112,'','')
        cartoon_flat_sheets       =(113,'','')
        cartoon_smooth_loops      =(114,'','')
        cartoon_dumbbell_length   =(115,'','')
        cartoon_dumbbell_width    =(116,'','')
        cartoon_dumbbell_radius   =(117,'','')
        cartoon_fancy_helices     =(118,'','')
        cartoon_fancy_sheets      =(119,'','')
        ignore_pdb_segi       =(120,'','')
        ribbon_throw          =(121,'','')
        cartoon_throw         =(122,'','')
        cartoon_refine        =(123,'','')
        cartoon_refine_tips   =(124,'','')
        cartoon_discrete_colors   =(125,'','')
        normalize_ccp4_maps   =(126,'','')
        surface_poor          =(127,'','')
        internal_feedback     =(128,'','')
        cgo_line_width        =(129,'','')
        cgo_line_radius       =(130,'','')
        logging               =(131,'','')
        robust_logs           =(132,'','')
        log_box_selections    =(133,'','')
        log_conformations     =(134,'','')
        valence_size          =(135,'','')
        valence_default       =(135,'','')
        surface_miserable     =(136,'','')
        ray_opaque_background =(137,'','')
        transparency          =(138,'','')
        ray_texture           =(139,'','')
        ray_texture_settings  =(140,'','')
        suspend_updates       =(141,'','')
        full_screen           =(142,'','')
        surface_mode          =(143,'','')
        surface_color         =(144,'','')
        mesh_mode             =(145,'','')
        mesh_color            =(146,'','')
        auto_indicate_flags   =(147,'','')
        surface_debug         =(148,'','')
        ray_improve_shadows   =(149,'','')
        smooth_color_triangle =(150,'','')
        ray_default_renderer  =(151,'','')
        field_of_view         =(152,'','')
        reflect_power         =(153,'','')
        preserve_chempy_ids   =(154,'','')
        sphere_scale          =(155,'','')
        two_sided_lighting    =(156,'','')
        secondary_structure   =(157,'','')
        auto_remove_hydrogens =(158,'','')
        raise_exceptions      =(159,'','')
        stop_on_exceptions    =(160,'','')
        sculpting             =(161,'','')
        auto_sculpt           =(162,'','')
        sculpt_vdw_scale      =(163,'','')
        sculpt_vdw_scale14    =(164,'','')
        sculpt_vdw_weight     =(165,'','')
        sculpt_vdw_weight14   =(166,'','')
        sculpt_bond_weight    =(167,'','')
        sculpt_angl_weight    =(168,'','')
        sculpt_pyra_weight    =(169,'','')
        sculpt_plan_weight    =(170,'','')
        sculpting_cycles      =(171,'','')
        sphere_transparency   =(172,'','')
        sphere_color          =(173,'','')
        sculpt_field_mask     =(174,'','')
        sculpt_hb_overlap     =(175,'','')
        sculpt_hb_overlap_base=(176,'','')
        legacy_vdw_radii      =(177,'','')
        sculpt_memory         =(178,'','')
        connect_mode          =(179,'','')
        cartoon_cylindrical_helices =( 180,'','')
        cartoon_helix_radius  =(181,'','')
        connect_cutoff        =(182,'','')
    #   save_pdb_ss           =(183,'','')
        sculpt_line_weight    =(184,'','')
        fit_iterations        =(185,'','')
        fit_tolerance         =(186,'','')
        batch_prefix          =(187,'','')
        stereo_mode           =(188,'','')
        cgo_sphere_quality    =(189,'','')
        pdb_literal_names     =(190,'','')
        wrap_output           =(191,'','')
        fog_start             =(192,'','')
        state                 =(193,'','')
        frame                 =(194,'','')
        ray_shadows           =(195, '','') # legacy
        ray_shadow            =(195, '','') # improved ease of use..(for ray_sh <Tab> ),'','')
        ribbon_trace_atoms    =(196,'','')
        security              =(197,'','')
        stick_transparency    =(198,'','')
        ray_transparency_shadows =( 199,'','')
        session_version_check =( 200,'','')
        ray_transparency_specular =( 201,'','')
        stereo_double_pump_mono =( 202,'','')
        sphere_solvent        =( 203,'','')
        mesh_quality          =( 204,'','')
        mesh_solvent          =( 205,'','')
        dot_solvent           =( 206,'','')
        ray_shadow_fudge      =( 207,'','')
        ray_triangle_fudge    =( 208,'','')
        debug_pick            =( 209,'','')
        dot_color             =( 210,'','')
        mouse_limit           =( 211,'','')
        mouse_scale           =( 212,'','')
        transparency_mode     =( 213,'','')
        clamp_colors          =( 214,'','')
        pymol_space_max_red   =( 215,'','')
        pymol_space_max_green =( 216,'','')
        pymol_space_max_blue  =( 217,'','')
        pymol_space_min_factor=( 218,'','')
        roving_origin         =( 219,'','')
        roving_lines          =( 220,'','')
        roving_sticks         =( 221,'','')
        roving_spheres        =( 222,'','')
        roving_labels         =( 223,'','')
        roving_delay          =( 224,'','')
        roving_selection      =( 225,'','')
        roving_byres          =( 226,'','')
        roving_ribbon         =( 227,'','')
        roving_cartoon        =( 228,'','')
        roving_polar_contacts =( 229,'','')
        roving_polar_cutoff   =( 230,'','')
        roving_nonbonded      =( 231,'','')
        float_labels          =( 232,'','')
        roving_detail         =( 233,'','')
        roving_nb_spheres     =( 234,'','')
        ribbon_color          =( 235,'','')
        cartoon_color         =( 236,'','')
        ribbon_smooth         =( 237,'','')
        auto_color            =( 238,'','')
        ray_interior_color    =( 240,'','')
        cartoon_highlight_color =( 241,'','')
        coulomb_units_factor  =( 242,'','')
        coulomb_dielectric    =( 243,'','')
        ray_interior_shadows  =( 244,'','')
        ray_interior_texture  =( 245,'','')
        roving_map1_name      =( 246,'','')
        roving_map2_name      =( 247,'','')
        roving_map3_name      =( 248,'','')
        roving_map1_level     =( 249,'','')
        roving_map2_level     =( 250,'','')
        roving_map3_level     =( 251,'','')
        roving_isomesh        =( 252,'','')
        roving_isosurface     =( 253,'','')
        scenes_changed        =( 254,'','')
        gaussian_b_adjust     =( 255,'','')
        pdb_standard_order    =( 256,'','')
        cartoon_smooth_first  =( 257,'','')
        cartoon_smooth_last   =( 258,'','')
        cartoon_smooth_cycles =( 259,'','')
        cartoon_flat_cycles   =( 260,'','')
        max_threads           =( 261,'','')
        show_progress         =( 262,'','')
        use_display_lists     =( 263,'','')
        cache_memory          =( 264,'','')
        simplify_display_lists=( 265,'','')
        retain_order          =( 266,'','')
        pdb_hetatm_sort       =( 267,'','')
        pdb_use_ter_records   =( 268,'','')
        cartoon_trace_atoms   =( 269,'','')
        ray_oversample_cutoff =( 270,'','')
        gaussian_resolution   =( 271,'','')
        gaussian_b_floor      =( 272,'','')
        sculpt_nb_interval    =( 273,'','')
        sculpt_tors_weight    =( 274,'','')
        sculpt_tors_tolerance =( 275,'','')
        stick_ball            =( 276,'','')
        stick_ball_ratio      =( 277,'','')
        stick_fixed_radius    =( 278,'','')
        cartoon_transparency  =( 279,'','')
        dash_round_ends       =( 280,'','')
        h_bond_max_angle      =( 281,'','')
        h_bond_cutoff_center  =( 282,'','')
        h_bond_cutoff_edge    =( 283,'','')
        h_bond_power_a        =( 284,'','')
        h_bond_power_b        =( 285,'','')
        h_bond_cone           =( 286,'','')
        ss_helix_psi_target   =( 287 ,'','')
        ss_helix_psi_include  =( 288,'','')
        ss_helix_psi_exclude  =( 289,'','')
        ss_helix_phi_target   =( 290,'','')
        ss_helix_phi_include  =( 291,'','')
        ss_helix_phi_exclude  =( 292,'','')
        ss_strand_psi_target  =( 293,'','')
        ss_strand_psi_include =( 294,'','')
        ss_strand_psi_exclude =( 295,'','')
        ss_strand_phi_target  =( 296,'','')
        ss_strand_phi_include =( 297,'','')
        ss_strand_phi_exclude =( 298,'','')
        movie_loop            =( 299,'','')
        pdb_retain_ids        =( 300,'','')
        pdb_no_end_record     =( 301,'','')
        cgo_dot_width         =( 302,'','')
        cgo_dot_radius        =( 303,'','')
        defer_updates         =( 304,'','')
        normalize_o_maps      =( 305,'','')
        swap_dsn6_bytes       =( 306,'','')
        pdb_insertions_go_first =( 307,'','')
        roving_origin_z         =( 308,'','')
        roving_origin_z_cushion =( 309,'','')
        specular_intensity    =( 310,'','')
        overlay_lines         =( 311,'','')
        ray_transparency_spec_cut =( 312,'','')
        internal_prompt       =( 313,'','')
        normalize_grd_maps    =( 314,'','')
        ray_blend_colors      =( 315,'','')
        ray_blend_red         =( 316,'','')
        ray_blend_green       =( 317,'','')
        ray_blend_blue        =( 318,'','')
        png_screen_gamma      =( 319,'','')
        png_file_gamma        =( 320,'','')
        editor_label_fragments =( 321,'','')
        internal_gui_control_size =( 322,'','')
        auto_dss              =( 323,'','')
        transparency_picking_mode =( 324,'','')
        virtual_trackball     =( 325,'','')
        pdb_reformat_names_mode =( 326,'','')
        ray_pixel_scale       =( 327,'','')
        label_font_id             =( 328,'','')
        pdb_conect_all            =( 329,'','')
        button_mode_name      =( 330,'','')
        surface_type          =( 331,'','')
        dot_normals           =( 332,'','')
        session_migration     =( 333,'','')
        mesh_normals          =( 334,'','')
        mesh_type             =( 335,'','')
        dot_lighting          =( 336,'','')
        mesh_lighting         =( 337,'','')
        surface_solvent       =( 338,'','')
        triangle_max_passes   =( 339,'','')
        ray_interior_reflect  =( 340,'','')
        internal_gui_mode     =( 341,'','')
        surface_carve_selection =( 342,'','')
        surface_carve_state   =( 343,'','')
        surface_carve_cutoff  =( 344,'','')
        surface_clear_selection =( 345,'','')
        surface_clear_state   =( 346,'','')
        surface_clear_cutoff  =( 347,'','')
        surface_trim_cutoff   =( 348,'','')
        surface_trim_factor   =( 349,'','')
        ray_max_passes        =( 350,'','')
        active_selections     =( 351,'','')
        ray_transparency_contrast =( 352,'','')
        seq_view              =( 353,'','')
        mouse_selection_mode  =( 354,'','')
        seq_view_label_spacing =( 355,'','')
        seq_view_label_start =( 356,'','')
        seq_view_format      =( 357,'','')
        seq_view_location    =( 358,'','')
        seq_view_overlay     =( 359,'','')
        auto_classify_atoms  =( 360,'','')
        cartoon_nucleic_acid_mode =( 361,'','')
        seq_view_color       =( 362,'','')
        seq_view_label_mode  =( 363,'','')
        surface_ramp_above_mode =( 364,'','')
        stereo               =( 365,'','')
        wizard_prompt_mode   =( 366,'','')
        coulomb_cutoff       =( 367,'','')
        slice_track_camera   =( 368,'','')
        slice_height_scale   =( 369,'','')
        slice_height_map     =( 370,'','')
        slice_grid           =( 371,'','')
        slice_dynamic_grid   =( 372,'','')
        slice_dynamic_grid_resolution =( 373,'','')
        pdb_insure_orthogonal =( 374,'','')
        ray_direct_shade     =( 375,'','')
        stick_color          =( 376, '', '')
        cartoon_putty_radius = ( 377, '', '')
        cartoon_putty_quality = ( 378, '', '')
        cartoon_putty_scale_min = (379, '', '')
        cartoon_putty_scale_max = (380, '', '')
        cartoon_putty_scale_power = (381, '', '')
        cartoon_putty_range = (382, '', '')
        cartoon_side_chain_helper = (383, '')            
        surface_optimize_subsets = (384, '')
        multiplex            = (385, '')
        texture_fonts             = (386, '')
        pqr_no_chain_id           = (387, '')
        animation                 = (388, '')
        animation_duration        = (389, '')
        scene_animation           = (390, '')
        line_stick_helper         = (391, '')
        ray_orthoscopic           = (392, '')
        ribbon_side_chain_helper  = (393, '')
        selection_width_max       = (394, '')
        selection_width_scale     = (395, '')
        scene_current_name        = (396, '')
        presentation              = (397, '')
        presentation_mode         = (398, '')
        pdb_truncate_residue_name = (399, '')
        scene_loop                = (400, '')
        sweep_mode                = (401, '')
        sweep_phase               = (402, '')
        scene_restart_movie_delay = (403, '')
        mouse_restart_movie_delay = (404, '')
        angle_size                = (405, '')
        angle_label_position      = (406, '')
        dihedral_size             = (407, '')
        dihedral_label_position   = (408, '')
        defer_builds_mode         = (409, '')
        seq_view_discrete_by_state= (410, '')
        scene_animation_duration  = (411, '')
        wildcard                  = (412, '')
        atom_name_wildcard        = (413, '')
        ignore_case               = (414, '')
        presentation_auto_quit    = (415, '')
        editor_auto_dihedral      = (416, '')
        presentation_auto_start   = (417, '')
        validate_object_names     = (418, '')
#        ray_pixel_scale_limit     = (419, '')
        auto_show_spheres         = (420, '')
        sphere_mode               = (421, '')
        sphere_point_max_size     = (422, '')
        sphere_point_size         = (423, '')
        pdb_honor_model_number    = (424, '')
        rank_assisted_sorts       = (425, '')
        ribbon_nucleic_acid_mode  = (426, '')
        cartoon_ring_mode         = (427, '')
        cartoon_ring_width        = (428, '')
        cartoon_ring_color        = (429, '')
        cartoon_ring_finder       = (430, '')
        cartoon_tube_cap          = (431, '')
        cartoon_loop_cap          = (432, '')
        nvidia_bugs               = (433, '')
        image_dots_per_inch       = (434, '')
        opaque_background         = (435, '')
        draw_frames               = (436, '')
        show_alpha_checker        = (437, '')
        matrix_mode               = (438, '')
        editor_auto_origin        = (439, '')
        session_file              = (440, '')
        cgo_transparency          = (441, '')
        legacy_mouse_zoom         = (442, '')
        auto_number_selections    = (443, '')
        sculpt_vdw_vis_mode       = (444, '')
        sculpt_vdw_vis_min        = (445, '')
        sculpt_vdw_vis_mid        = (446, '')
        sculpt_vdw_vis_max        = (447, '')
        cartoon_ladder_mode       = (448, '')
        cartoon_ladder_radius     = (449, '')
        cartoon_ladder_color      = (450, '')
        cartoon_nucleic_acid_color= (451, '')
        cartoon_ring_transparency = (452, '')
        label_size                = (453, '')
        spec_direct               = (454, '')
        light_count               = (455, '')
        light2                    = (456, '')
        light3                    = (457, '')
        hide_underscore_names     = (458, '')
        selection_round_points    = (459, '')
        distance_exclusion        = (460, '')
        h_bond_exclusion          = (461, '')
        label_shadow_mode         = (462, '')
        light4                    = (463, '')
        light5                    = (464, '')
        light6                    = (465, '')
        light7                    = (466, '')
        label_outline_color       = (467, '')
        ray_trace_mode            = (468, '')
        ray_trace_gain            = (469, '')
        selection_visible_only    = (470, '')
        label_position            = (471, '')
        ray_trace_depth_factor    = (472, '')
        ray_trace_slope_factor    = (473, '')
        ray_trace_disco_factor    = (474, '')
        ray_shadow_decay_factor   = (475, '')
        ray_interior_mode         = (476, '')
        ray_legacy_lighting       = (477, '')
        sculpt_auto_center        = (478, '')
        pdb_discrete_chains       = (479, '')
        pdb_unbond_cations        = (480, '')
        sculpt_tri_scale          = (481, '')
        sculpt_tri_weight         = (482, '')
        sculpt_tri_min            = (483, '')
        sculpt_tri_max            = (484, '')
        sculpt_tri_mode           = (485, '')
        pdb_echo_tags             = (486, '')
        connect_bonded            = (487, '')
        spec_direct_power         = (488, '')
        light8                    = (489, '')
        light9                    = (490, '')
        ray_shadow_decay_range    = (491, '')
        spec_count                = (492, '')
        sculpt_min_scale          = (493, '')
        sculpt_min_weight         = (494, '')
        sculpt_min_min            = (495, '')
        sculpt_min_max            = (496, '')
        sculpt_max_scale          = (497, '')
        sculpt_max_weight         = (498, '')
        sculpt_max_min            = (499, '')
        sculpt_max_max            = (500, '')
        surface_circumscribe      = (501, '')
        sculpt_avd_weight         = (502, '')
        sculpt_avd_gap            = (503, '')
        sculpt_avd_range          = (504, '')
        sculpt_avd_excl           = (505, '')
        async_builds              = (506, '')
        fetch_path                = (507, '')
        cartoon_ring_radius       = (508, '')
        ray_color_ramps           = (509, '')
        ray_hint_camera           = (510, '')
        ray_hint_shadow           = (511, '')
        stick_valence_scale       = (512, '')
        
    setting_sc = Shortcut(SettingIndex.__dict__.keys())

    index_list = []
    name_dict = {}
    name_list = SettingIndex.__dict__.keys()
    name_list = filter(lambda x:x[0]!='_',name_list)
    name_list.sort()
    tmp_list = map(lambda x:(getattr(SettingIndex,x)[0],x),name_list)
    for a in tmp_list:
        name_dict[a[0]]=a[1]
        index_list.append(a[0])

    boolean_dict = {
        "true" : 1,
        "false" : 0,
        "on"   : 1,
        "off"  : 0,
        "1"    : 1,
        "0"    : 0,
        "1.0"  : 1,
        "0.0"  : 0,
        }

    boolean_sc = Shortcut(boolean_dict.keys())

    quote_strip_re = re.compile("^\'.*\'$|^\".*\"$")

    def _get_index(name):
        # this may be called from C, so don't raise any exceptions...
        result = setting_sc.interpret(name)
        if type(result)==types.StringType:
            if hasattr(SettingIndex,result):
                return getattr(SettingIndex,result)[0]
            else:
                return -1
        else:
            return -1

    def _get_name(index): # likewise, this can be called from C so no exceptions
        if name_dict.has_key(index):
            return name_dict[index]
        else:
            return ""

    def get_index_list():
        return index_list

    def get_name_list():
        return name_list

    ###### API functions

    def set(name,value=1,selection='',state=0,updates=1,log=0,quiet=1):
        '''
DESCRIPTION

    "set" changes one of the PyMOL state variables,

USAGE

    set name, [,value [,object-or-selection [,state ]]]

    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. 

        '''
        r = DEFAULT_ERROR
        selection = str(selection)
        if log:
            if ',' in str(value):
                value = str(cmd.safe_list_eval(str(value)))
            if len(selection):
                cmd.log("set %s,%s,%s\n"%(str(name),str(value),str(selection)))
            else:
                cmd.log("set %s,%s\n"%(str(name),str(value)))            
        index = _get_index(str(name))
        if(index<0):
            print "Error: unknown setting '%s'."%name
            raise QuietException
        else:
            try:
                lock()
                type = _cmd.get_setting_tuple(int(index),str(""),int(-1))[0]
                if type==None:
                    print "Error: unable to get setting type."
                    raise QuietException
                try:
                    if type==1: # boolean (also support non-zero float for truth)
                        handled = 0
                        if boolean_sc.interpret(str(value))==None:
                            try: # number, non-zero, then interpret as TRUE
                                if not (float(value)==0.0):
                                    handled = 1
                                    v = (1,)
                                else:
                                    handled = 1
                                    v = (0,)
                            except:
                                pass
                        if not handled:
                            v = (boolean_dict[
                                boolean_sc.auto_err(
                                str(value),"boolean")],)
                    elif type==2: # int (also supports boolean language for 0,1)
                        if boolean_sc.has_key(str(value)):
                            v = (boolean_dict[
                                boolean_sc.auto_err(
                                str(value),"boolean")],)
                        else:
                            v = (int(value),)
                    elif type==3: # float
                        if boolean_sc.has_key(str(value)):
                            v = (float(boolean_dict[
                                boolean_sc.auto_err(
                                str(value),"boolean")]),)
                        else:
                            v = (float(value),)
                    elif type==4: # float3 - some legacy handling req.
                        if is_string(value):
                            if not ',' in value:
                                v = string.split(value)
                            else:
                                v = eval(value)
                        else:
                            v = value
                        v = (float(v[0]),float(v[1]),float(v[2]))
                    elif type==5: # color
                        v = (str(value),)
                    elif type==6: # string
                        vl = str(value)
                        # strip outermost quotes (cheesy approach)
                        if quote_strip_re.search(vl)!=None:
                            vl=vl[1:-1]
                        v = (vl,)
                    v = (type,v)
                    if len(selection):
                        selection=selector.process(selection)
                    r = _cmd.set(int(index),v,
                                     selection,
                                     int(state)-1,int(quiet),
                                     int(updates))
                except:
                    traceback.print_exc()
                    if(_feedback(fb_module.cmd,fb_mask.debugging)):
                        traceback.print_exc()
                        print "Error: unable to read setting value."
                    raise QuietException
            finally:
                unlock()
        if _raising(r): raise QuietException            
        return r

    def unset(name,selection='',state=0,updates=1,log=0,quiet=1):
        '''
DESCRIPTION

    "unset" behaves in two ways.

    If selection is not provided, unset changes the named global
    setting to a zero or off value.

    If a selection is provided, then "unset" undefines 
    object-specific or state-specific settings so that the global
    setting will be in effect.

USAGE

    unset name [,selection [,state ]]

PYMOL API

    cmd.unset ( string name, string selection = '',
                int state=0, int updates=1, int log=0 )

        '''
        r = DEFAULT_ERROR
        selection = str(selection)
        if log:
            if(len(selection)):
                cmd.log("unset %s,%s\n"%(str(name),str(selection)))
            else:
                cmd.log("set %s,0\n"%(str(name)))
        index = _get_index(str(name))
        if(index<0):
            print "Error: unknown setting '%s'."%name
            raise QuietException
        else:
            if not len(selection):
                r = set(name,0,'',state,updates,log=0,quiet=quiet)
            else:
                try:
                    lock()
                    try:
                        selection = selector.process(selection)   
                        r = _cmd.unset(int(index),selection,
                                            int(state)-1,int(quiet),
                                            int(updates))
                    except:
                        if(_feedback(fb_module.cmd,fb_mask.debugging)):
                            traceback.print_exc()
                            raise QuietException
                        print "Error: unable to unset setting value."
                finally:
                    unlock()
        if _raising(r): raise QuietException            
        return r

    def get_setting(name,object='',state=0): # INTERNAL
        r = DEFAULT_ERROR
        if is_string(name):
            i = _get_index(name)
        else:
            i = int(name)
        if i<0:
            print "Error: unknown setting"
            raise QuietException
        try:
            lock()
            r = _cmd.get_setting_tuple(i,str(object),int(state)-1)
            typ = r[0]
            if typ<3: # boolean, int
                value = int(r[1][0])
            elif typ<4: # float
                value = r[1][0]
            elif typ<5: # vector
                value = r[1]
            else:
                value = r[1] # color or string
        finally:
            unlock()
        if is_ok(r):
            return value
        elif _raising(r):
            raise QuietException                     
        return r

    def get(name,object='',state=0,quiet=1):
        r = DEFAULT_ERROR
        state = int(state)
        if is_string(name):
            i = _get_index(name)
        else:
            i = int(name)
        if i<0:
            print "Error: unknown setting"
            raise QuietException
        try:
            lock()
            r = _cmd.get_setting_text(i,str(object),state-1)
        finally:
            unlock()
        if is_ok(r) and (r!=None):
            r_str = str(r)
            if len(string.strip(r_str))==0:
                r_str = "\'"+r_str+"\'"
            if not quiet:
                if(object==''):
                    print " get: %s = %s"%(name,r_str)
                elif state<=0:
                    print " get: %s = %s in object %s"%(name,r_str,object)
                else:
                    print " get: %s = %s in object %s state %d"%(name,r_str,object,state)
        if _raising(r): raise QuietException
        return r
    
    def get_setting_tuple(name,object='',state=0): # INTERNAL
        r = DEFAULT_ERROR
        if is_string(name):      i = _get_index(name)
        else:
            i = int(name)
        if i<0:
            print "Error: unknown setting"
            raise QuietException
        try:
            lock()
            r = _cmd.get_setting_tuple(i,str(object),int(state)-1)
        finally:
            unlock()
        if _raising(r): raise QuietException
        return r

    def get_setting_text(name,object='',state=0):  # INTERNAL
        r = DEFAULT_ERROR
        if is_string(name):
            i = _get_index(name)
        else:
            i = int(name)
        if i<0:
            print "Error: unknown setting"
            raise QuietException
        try:
            lock()
            r = _cmd.get_setting_text(i,str(object),int(state)-1)
        finally:
            unlock()
        if _raising(r): raise QuietException
        return r

    def get_setting_updates(): # INTERNAL
        r = []
        if lock_attempt():
            try:
                r = _cmd.get_setting_updates()
            finally:
                unlock()
        return r

    def get_setting_legacy(name): # INTERNAL, DEPRECATED
        r = DEFAULT_ERROR
        try:
            lock()
            r = _cmd.get_setting(name)
        finally:
            unlock()
        if _raising(r): raise QuietException
        return r


Generated by  Doxygen 1.6.0   Back to index