manipRotateContext

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

manipRotateContext( [object] , [activeHandle=int], [alignAlong=[float, float, float]], [constrainAlongNormal=boolean], [currentActiveHandle=int], [editPivotMode=boolean], [editPivotPosition=boolean], [exists=boolean], [image1=string], [image2=string], [image3=string], [lastMode=int], [manipVisible=boolean], [mode=int], [modifyTranslation=boolean], [orientAxes=[float, float, float]], [orientObject=string], [orientTowards=[float, float, float]], [pinPivot=boolean], [pivotOriHandle=boolean], [position=boolean], [postCommand=script], [postDragCommand=[script, string]], [preCommand=script], [preDragCommand=[script, string]], [preserveChildPosition=boolean], [preserveUV=boolean], [reflection=boolean], [reflectionAbout=int], [reflectionAxis=int], [reflectionTolerance=float], [rotate=[float, float, float]], [snapPivotOri=boolean], [snapPivotPos=boolean], [tweakMode=boolean], [useCenterPivot=boolean], [useManipPivot=boolean], [useObjectPivot=boolean], [xformConstraint=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

manipRotateContext is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
activeHandle(ah)	int
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 active 1 - Y axis handle is active 2 - Z axis handle is active 3 - View rotation handle (outer ring) is active (default)
alignAlong(aa)	[float, float, float]
Aligns active handle along vector.
constrainAlongNormal(xn)	boolean
When true, transform constraints are applied along the vertex normal first and only use the closest point when no intersection is found along the normal.
currentActiveHandle(cah)	int
Sets the active handle for the manip. Values can be: 0 - X axis handle is active 1 - Y axis handle is active 2 - Z axis handle is active 3 - View rotation handle (outer ring) is active 4 - Arc Ball is active
editPivotMode(epm)	boolean
Returns true manipulator is in edit pivot mode
editPivotPosition(epp)	boolean
Returns the current position of the edit pivot manipulator.
exists(ex)	boolean
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
image1(i1)	string
First of three possible icons representing the tool associated with the context.
image2(i2)	string
Second of three possible icons representing the tool associated with the context.
image3(i3)	string
Third of three possible icons representing the tool associated with the context.
lastMode(lm)	int
Returns the previous rotation mode.
manipVisible(vis)	boolean
Returns true if the rotate manipulator is visible.
mode(m)	int
Arcball mode (0 - Object Space (default), 1 - World Space, 2 - Gimbal Mode, 3 - Custom Axis Orientation), 9 - Component Space
modifyTranslation(mt)	boolean
When false, and an object is rotated about a point other than its rotate pivot, its rotateTranslate attribute is modified to put the object at the correct position. When true, its translate attribute is used instead. Default is false.
orientAxes(oa)	[float, float, float]
Orients manipulator rotating around axes by specified angles
orientObject(oo)	string
Orients manipulator to the passed in object/component
orientTowards(ot)	[float, float, float]
Orients active handle towards world point
pinPivot(pin)	boolean
Pin component pivot. When the component pivot is set and pinned selection changes will not reset the pivot position and orientation.
pivotOriHandle(poh)	boolean
When true, the pivot manipulator will show the orientation handle during editing. Default is true.
position(p)	boolean
Returns the current position of the manipulator.
postCommand(psc)	script
Specifies a command to be executed when the tool is exited.
postDragCommand(pod)	[script, string]
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
Specifies a command to be executed when the tool is entered.
preDragCommand(prd)	[script, string]
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)	boolean
When false, the children objects move when their parent is rotated. When true, the worldspace position of the children will be maintained as the parent is moved. Default is false.
preserveUV(puv)	boolean
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)	boolean
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.
rotate(ro)	[float, float, float]
Returns the rotation of the manipulator for its current orientation/mode.
snapPivotOri(spo)	boolean
Snap pivot orientation. Modify pivot orientation when snapping the pivot to a component.
snapPivotPos(spp)	boolean
Snap pivot position. Modify pivot position when snapping the pivot to a component.
tweakMode(twk)	boolean
When true, the manipulator is hidden and highlighted components can be selected and rotated in one step using a click-drag interaction.
useCenterPivot(ucp)	boolean
When true, use the center of the selection's bounding box as the center of the rotation (for all objects).
useManipPivot(ump)	boolean
When true, use the manipulator's center as the center of the rotation (for all objects).
useObjectPivot(uop)	boolean
When true, use each object's pivot as the center of its rotation.
xformConstraint(xc)	string
none - no transform constraint edge - edge transform constraint surface - surface transform constraint

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# To create a new rotate context:
cmds.manipRotateContext()

# To query the mode of an existing context:
cmds.manipRotateContext( 'manipRotateContext1', q=True, mode=True )

# To edit an existing context to come up with the X axis
# handle active by default:
cmds.manipRotateContext( 'manipRotateContext1', e=True, ah=0 )