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

Synopsis

tumbleCtx([alternateContext=boolean], [autoOrthoConstrain=boolean], [autoSetPivot=boolean], [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [localTumble=int], [name=string], [objectTumble=boolean], [orthoLock=boolean], [orthoStep=angle], [toolName=string], [tumbleScale=float])

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

tumbleCtx is undoable, queryable, and editable.

This command can be used to create, edit, or query a tumble context.

Return value

stringThe name of the context

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

Flags

alternateContext, autoOrthoConstrain, autoSetPivot, exists, history, image1, image2, image3, localTumble, name, objectTumble, orthoLock, orthoStep, toolName, tumbleScale
Long name (short name) Argument types Properties
alternateContext(ac) boolean createquery
Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context.
autoOrthoConstrain(aoc) boolean createqueryedit
Automatically constrain horizontal and vertical rotations when the camera is orthographic. The shift key can be used to unconstrain the rotation.
autoSetPivot(asp) boolean createqueryedit
Automatically set the camera pivot to the selection or tool effect region
exists(ex) boolean create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
history(ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
image1(i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
image2(i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
image3(i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
localTumble(lt) int createqueryedit
Describes what point the camera will tumble around:
  • 0 for the camera's tumble pivot
  • 1 for the camera's center of interest
  • 2 for the camera's local axis, offset by its tumble pivot
name(n) string create
If this is a tool command, name the tool appropriately.
objectTumble(ot) boolean createqueryedit
Make the camera tumble around the selected object, if true.
orthoLock(ol) boolean createqueryedit
Orthographic cameras cannot be tumbled while orthoLock is on.
orthoStep(os) angle createqueryedit
Specify the angular step in degrees for orthographic rotation. If camera is orthographic and autoOrthoConstrain is toggled on the rotation will be stepped by this amount.
toolName(tn) string createquery
Name of the specific tool to which this command refers.
tumbleScale(ts) float createqueryedit
Set the rotation speed. A tumble scale of 1.0 will result in in 40 degrees of rotation per 100 pixels of cursor drag.

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

cmds.tumbleCtx( 'tumbleContext', ts=1.0, lt=False, ac=False, ol=True )