pymel.core.context.manipMoveContext — PyMEL 1.0.7 documentation

pymel.core.context.manipMoveContext

manipMoveContext(*args, **kwargs)

This command can be used to create, edit, or query a move manip context. Note that the flags -s, -sv, -sr, -scr, -slp, -slf control the global behaviour of all move manip context. Changing one context independently is not allowed. Changing a context’s behaviour using the above flags, will change all existing move manip context.

Flags:

Long Name / Short Name Argument Types Properties
activeHandle / ah int ../../../_images/query.gif ../../../_images/edit.gif
 

Sets the default active handle for the manip. That is, the handle which should be initially active when the tool is activated. Values can be: 0 - X axis handle is active1 - Y axis handle is active2 - Z axis handle is active3 - Center handle (all 3 axes) is active (default)

activeHandleNormal / ahn int ../../../_images/query.gif ../../../_images/edit.gif
 

0 - U axis handle is active1 - V axis handle is active2 - N axis handle is active ( default )3 - Center handle (all 3 axes) is activeapplicable only when the manip mode is 3.

alignAlong / aa float, float, float ../../../_images/create.gif ../../../_images/edit.gif
 
Aligns active handle along vector.
currentActiveHandle / cah int ../../../_images/query.gif ../../../_images/edit.gif
 

Sets the active handle for the manip. Values can be: 0 - X axis handle is active1 - Y axis handle is active2 - Z axis handle is active3 - Center handle (all 3 axes) is active4 - XY plane handle is active5 - YZ plane handle is active6 - XZ plane handle is active

editPivotMode / epm bool ../../../_images/query.gif
 
Returns true manipulator is in edit pivot mode
editPivotPosition / epp bool ../../../_images/query.gif
 
Returns the current position of the edit pivot manipulator.
exists / ex bool  
   
image1 / i1 unicode  
   
image2 / i2 unicode  
   
image3 / i3 unicode  
   
interactiveUpdate / iu bool ../../../_images/query.gif ../../../_images/edit.gif
 
Value can be : true or false. This flag value is valid only if the mode is 3 i.e. move vertex normal.
lastMode / lm int ../../../_images/query.gif
 
Returns the previous translation mode.
manipVisible / vis bool ../../../_images/query.gif
 
Returns true if the main translate manipulator is visible.
mode / m int ../../../_images/query.gif ../../../_images/edit.gif
 

Translate mode: 0 - Object Space1 - Local Space2 - World Space (default)3 - Move Along Vertex Normal4 - Move Along Rotation Axis5 - Move Along Live Object Axis6 - Custom Axis Orientation9 - Component Space

orientAxes / oa float, float, float ../../../_images/query.gif ../../../_images/edit.gif
 
Orients manipulator rotating around axes by specified angles
orientJoint / oj unicode ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the type of orientation for joint orientation. Valid options are: none, xyz, xzy, yxz, yzx, zxy, zyx.
orientJointEnabled / oje bool ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies if joints should be reoriented when moved.
orientTowards / ot float, float, float ../../../_images/create.gif ../../../_images/edit.gif
 
Orients active handle towards world point
pinPivot / pin bool ../../../_images/query.gif ../../../_images/edit.gif
 
Pin component pivot. When the component pivot is set and pinned selection changes will not reset the pivot position and orientation.
position / p bool ../../../_images/query.gif
 
Returns the current position of the manipulator
postCommand / psc script ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies a command to be executed when the tool is exited.
postDragCommand / pod script, <type ‘unicode’> ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies a command and a node type. The command will be executed at the end of a drag when a node of the specified type is in the selection.
preCommand / prc script ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies a command to be executed when the tool is entered.
preDragCommand / prd script, <type ‘unicode’> ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies a command and a node type. The command will be executed at the start of a drag when a node of the specified type is in the selection.
preserveChildPosition / pcp bool ../../../_images/query.gif ../../../_images/edit.gif
 

When false, the children objects move when their parent is moved. When true, the worldspace position of the children will be maintained as the parent is moved. Default is false.

preserveUV / puv bool ../../../_images/query.gif ../../../_images/edit.gif
 

When false, the uvs are not changes to match the vertex edit. When true, the uvs are edited to project to new values to stop texture swimming as vertices are moved.

reflection / rfl bool  
 
This flag is obsolete. Reflection is now managed as part of selection itself using the symmetricModeling command.
reflectionAbout / rab int  
 
This flag is obsolete. Reflection is now managed as part of selection itself using the symmetricModeling command.
reflectionAxis / rfa int  
 
This flag is obsolete. Reflection is now managed as part of selection itself using the symmetricModeling command.
reflectionTolerance / rft float  
 
This flag is obsolete. Reflection is now managed as part of selection itself using the symmetricModeling command.
secondaryAxisOrient / sao unicode ../../../_images/query.gif ../../../_images/edit.gif
 

Specifies the global axis (in world coordinates) that should be used to should be used to align the second axis of the orientJointType triple. Valid options are xup, yup, zup, xdown, ydown, zdown, none.

snap / s bool ../../../_images/query.gif ../../../_images/edit.gif
 

Value can be : true or false. Enable/Disable the discrete move. If set to true, the move manipulator of all the move contexts would snap at discrete points along the active handle during mouse drag. The interval between the points can be controlled using the ‘snapValue’ flag.

snapComponentsRelative / scr bool ../../../_images/query.gif ../../../_images/edit.gif
 

Value can be : true or false. If true, while snapping a group of CVs/Vertices, the relative spacing between them will be preserved. If false, all the CVs/Vertices will be snapped to the target point (is used during grid snap(hotkey ‘x’), and point snap(hotkey ‘v’)) Depress the ‘x’ key before click-dragging the manip handle and check to see the behaviour of moving a bunch of CVs, with this flag ON and OFF.

snapLiveFaceCenter / slf bool ../../../_images/query.gif ../../../_images/edit.gif
 
Value can be : true or false. If true, while moving on the live polygon object, the move manipulator will snap to the face centers of the object.
snapLivePoint / slp bool ../../../_images/query.gif ../../../_images/edit.gif
 
Value can be : true or false. If true, while moving on the live polygon object, the move manipulator will snap to the vertices of the object.
snapPivotOri / spo bool ../../../_images/query.gif ../../../_images/edit.gif
 
Snap pivot orientation. Modify pivot orientation when snapping the pivot to a component.
snapPivotPos / spp bool ../../../_images/query.gif ../../../_images/edit.gif
 
Snap pivot position. Modify pivot position when snapping the pivot to a component.
snapRelative / sr bool ../../../_images/query.gif ../../../_images/edit.gif
 

Value can be : true or false. Applicable only when the snap is enabled. If true, the snapValue is treated relative to the original position before moving. If false, the snapValue is treated relative to the world origin. NOTE: If in local/object Space Mode, the snapRelative should be ON. Absolute discrete move is not supported in local/object mode.

snapValue / sv float ../../../_images/query.gif ../../../_images/edit.gif
 
Applicable only when the snap is enabled. The manipulator of all move contexts would move in steps of ‘snapValue’
translate / tr float, float, float ../../../_images/query.gif ../../../_images/edit.gif
 

Returns the translation of the manipulator for its current orientation/mode. Flag can have multiple arguments, passed either as a tuple or a list.

tweakMode / twk bool ../../../_images/query.gif ../../../_images/edit.gif
 
When true, the manipulator is hidden and highlighted components can be selected and moved in one step using a click-drag interaction.
xformConstraint / xc unicode ../../../_images/query.gif ../../../_images/edit.gif
 
none - no transform constraintedge - edge transform constraintsurface - surface transform constraint

Derived from mel command maya.cmds.manipMoveContext

Example:

import pymel.core as pm

# To create a new move context:
pm.manipMoveContext()
# Result: u'manipMoveContext1' #

# To query the mode of an existing context:
pm.manipMoveContext( 'manipMoveContext1', q=True, mode=True )
# Result: 2 #

# To edit an existing context to come up with the X axis handle
# active by default:
pm.manipMoveContext( 'manipMoveContext1', e=True, ah=0 )
# Result: u'manipMoveContext1' #

pm.spaceLocator( p=(0, 0, 0), name='locatorA' )
# Result: nt.Transform(u'locatorA') #

pm.manipMoveContext( 'manipMoveContext1', e=True, m=2 ) # WorldSpace
# Result: u'manipMoveContext1' #
pm.manipMoveContext( 'manipMoveContext1', e=True, snap=True )
# Result: u'manipMoveContext1' #
pm.manipMoveContext( 'manipMoveContext1', e=True, snapValue=0.4 )
# Result: u'manipMoveContext1' #
# Now, dragging any of the move handles will
# move the object in steps of 0.4 units.

pm.move( 0.8, 0, 0, 'locatorA', a=True )
pm.manipMoveContext( 'manipMoveContext1', e=True, snap=True )
# Result: u'manipMoveContext1' #
pm.manipMoveContext( 'manipMoveContext1', e=True, snapValue=2 )
# Result: u'manipMoveContext1' #
pm.manipMoveContext( 'manipMoveContext1', e=True, snapRelative=False )
# Result: u'manipMoveContext1' #
# Now, dragging X-axis handle will
# move the object in steps of 2 units, and will
# place the object anywhere in (0,0,0) (2,0,0) (4,0,0) ...etc
# NOTE: If in objectSpace Mode, the snapRelative should be ON.
# Absolute discrete move is not supported in objectSpace mode.

pm.move( 0.8, 0, 0, 'locatorA', a=True )
pm.manipMoveContext( 'manipMoveContext1', e=True, snap=True )
# Result: u'manipMoveContext1' #
pm.manipMoveContext( 'manipMoveContext1', e=True, snapValue=2 )
# Result: u'manipMoveContext1' #
pm.manipMoveContext( 'manipMoveContext1', e=True, snapRelative=True )
# Result: u'manipMoveContext1' #
# Now, dragging X-axis handle will
# move the object in steps of 2 units, and will
# place the object anywhere in (2.8,0,0) (4.8,0,0) (6.8,0,0) ...etc