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

Synopsis

curveSketchCtx( [object] , [degree=uint], [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.

curveSketchCtx is undoable, queryable, and editable.

The curveSketchCtx command creates a new curve sketch context, also known as the "pencil context".

Return value

string(name of the new curve sketch context)

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

Flags

degree, exists, history, image1, image2, image3, name
Long name (short name) Argument types Properties
degree(d) uint createqueryedit
Valid values are 1 or 3
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

# To create a new sketch context, which creates degree 3 curves:
cmds.curveSketchCtx( "pencilContext", degree=3 )
cmds.setToolTo("pencilContext")

# To query the degree of an existing context:
cmds.curveSketchCtx( "pencilContext",q=True, degree=True )

# To edit the degree of an existing context:
cmds.curveSketchCtx( "pencilContext", e=True, degree=1 )