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

Synopsis

view2dToolCtx([alternateContext=boolean], [boxzoom=boolean], [dolly=boolean], [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string], [toolName=string], [track=boolean])

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

view2dToolCtx is undoable, queryable, and editable.

This class creates a context for the View Tools "track", "dolly", and "box zoom" in the Hypergraph.

Return value

stringThe context name

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

Flags

alternateContext, boxzoom, dolly, exists, history, image1, image2, image3, name, toolName, track
Long name (short name) Argument types Properties
alternateContext(ac) boolean createquery
Set the ALT+MMB and ALT+SHIFT+MMB to refer to this context.
boxzoom(bz) boolean createquery
Perform Box Zoom
dolly(do) boolean createquery
Dollies the view
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.
name(n) string create
If this is a tool command, name the tool appropriately.
toolName(tn) string createquery
Name of the specific tool to which this command refers.
track(tr) boolean createquery
Tracks the view

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

# Create a new view2dTool context, set it to do dolly in the Hypergraph window, then switch to this tool
cmds.view2dToolCtx('view2dToolCtx1', dolly=True)
cmds.setToolTo('view2dToolCtx1')