pymel.core.general.selectPref

selectPref(*args, **kwargs)

This command controls state variables used to selection UI behavior.

Flags:
Long name (short name) Argument Types Properties
affectsActive (aa) bool ../../../_images/create.gif ../../../_images/query.gif
 
Set affects-active toggle which when on causes the active list to be affected when changing between object and component selection mode.
allowHiliteSelection (ahs) bool ../../../_images/create.gif ../../../_images/query.gif
 

When in component selection mode, allow selection of objects for editing. If an object is selected for editing, it appears in the hilite color and its selectable components are automatically displayed.

autoSelectContainer (asc) bool ../../../_images/query.gif
 

When enabled, with container centric selection also on, whenever the root transform is selected in the viewport, the container node will automatically be selected as well.

clickBoxSize (cbs) int ../../../_images/create.gif ../../../_images/query.gif
 

When click selecting, this value defines the size of square picking region surrounding the cursor. The size of the square is twice the specified value. That is, the value defines the amount of space on all four sides of the cursor position. The size must be positive.

clickDrag (cld) bool ../../../_images/create.gif ../../../_images/query.gif
 
Set click/drag selection interaction on/off
containerCentricSelection (ccs) bool ../../../_images/query.gif
 

When enabled, selecting any DAG node in a container in the viewport will select the container’s root transform if there is one. If there is no root transform then the highest DAG node in the container will be selected. There is no effect when selecting nodes which are not in a container.

disableComponentPopups (dcp) bool ../../../_images/create.gif ../../../_images/query.gif
 
A separate preference to allow users to disable popup menus when selecting components. This pref is only meaningful if the popupMenuSelection pref is enabled.
expandPopupList (epl) bool ../../../_images/create.gif ../../../_images/query.gif
 

When in popup selection mode, if this is set then all selection items that contain multiple objects or components will be be expanded such that each object or component will be a single new selection item.

ignoreSelectionPriority (isp) bool ../../../_images/create.gif ../../../_images/query.gif
 
If this is set, selection priority will be ignored when performing selection.
manipClickBoxSize (mcb) int ../../../_images/create.gif ../../../_images/query.gif
 

When selecting a manipulator, this value defines the size of square picking region surrounding the cursor. The size of the square is twice the specified value. That is, the value defines the amount of space on all four sides of the cursor position. The size must be positive.

paintSelect (ps) bool  
   
paintSelectWithDepth (psd) bool  
   
popupMenuSelection (pms) bool ../../../_images/create.gif ../../../_images/query.gif
 

If this is set, a popup menu will be displayed and used to determine the object to select. The menu lists the current user box (marquee) of selected candidate objects.

preSelectHilite (psh) bool  
   
preSelectHiliteSize (phs) float  
   
selectTypeChangeAffectsActive (stc) bool  
   
selectionChildHighlightMode (sch) int ../../../_images/create.gif ../../../_images/query.gif
 

Controls the highlighting of the children of a selected object. Valid modes are: 0: Always highlight children 1: Never highlight children 2: Use per-object “Selection Child Highlight” setting. Default mode is (0): Always highlight children. For (2), each DAG object has an individual “Selection Child Highlight” boolean flag. By default, this flag will be TRUE. When mode (2) is enabled, the control is deferred to the selected object’s “Selection Child Highlight” flag.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

singleBoxSelection (sbs) bool ../../../_images/create.gif ../../../_images/query.gif
 

Set single box selection on/off. This flag indicates whether just single object will be selected when the user box (marquee) selects several objects if flag set to true. Otherwise, all those objects inside the box will be selected.

straightLineDistance (sld) bool  
   
trackSelectionOrder (tso) bool ../../../_images/query.gif
 

When enabled, the order of selected objects and components will be tracked. The ‘ls’ command will be able to return the active list in the order of selection which will allow scripts to be written that depend on the order.

useDepth (ud) bool  
   
xformNoSelect (xns) bool ../../../_images/create.gif ../../../_images/query.gif
 
Disable selection in xform tools

Derived from mel command maya.cmds.selectPref

Example:

import pymel.core as pm

pm.selectPref(popupMenuSelection=True,disableComponentPopups=True)

Previous topic

pymel.core.general.selectMode

Next topic

pymel.core.general.selectPriority

Core

Core Modules

Other Modules

This Page