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

Synopsis

paramDimContext([exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [name=string])

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

paramDimContext is undoable, queryable, and editable.

Command used to register the paramDimCtx tool.

Return value

string- name of the context created

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

Flags

exists, history, image1, image2, image3, name
Long name (short name) Argument types Properties
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.

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.paramDimContext()