sculpt

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

Synopsis

sculpt( selectionList , [after=boolean], [afterReference=boolean], [before=boolean], [deformerTools=boolean], [dropoffDistance=linear], [dropoffType=string], [exclusive=string], [frontOfChain=boolean], [geometry=string], [geometryIndices=boolean], [groupWithLocator=boolean], [ignoreSelected=boolean], [insideMode=string], [maxDisplacement=linear], [mode=string], [name=string], [objectCentered=boolean], [parallel=boolean], [prune=boolean], [remove=boolean], [sculptTool=string], [split=boolean])

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

sculpt is undoable, queryable, and editable.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
name(n)	string
Used to specify the name of the node being created
geometry(g)	string
The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is also specified. When queried, this flag returns string string string ...
geometryIndices(gi)	boolean
Complements the -geometry flag in query mode. Returns the multi index of each geometry.
remove(rm)	boolean
Specifies that objects listed after the -g flag should be removed from this deformer.
before(bf)	boolean
If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
after(af)	boolean
If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
afterReference(ar)	boolean
The -afterReference flag is used to specify deformer ordering in a hybrid way that choses between -before and -after automatically. If the geometry being deformed is referenced then -after mode is used in adding the new deformer otherwise -before mode is used. The net effect when using -afterReference to build deformer chains is that internal shape nodes in the deformer chain will only appear at reference file boundaries, leading to lightweight deformer networks that may be more amicable to reference swapping.
split(sp)	boolean
Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
frontOfChain(foc)	boolean
This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and skin nodes in the shape's history (but not ahead of existing tweak nodes). The input to the deformer will be the upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and edit mode if the deformer has no geometry added yet).
parallel(par)	boolean
Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry added yet).
ignoreSelected(ignoreSelected)	boolean
Tells the command to not deform objects on the current selection list
deformerTools(dt)	boolean
Returns the name of the deformer tool objects (if any) as string string ...
prune(pr)	boolean
Removes any points not being deformed by the deformer in its current configuration from the deformer set.
exclusive(ex)	string
Puts the deformation set in a deform partition.
mode(m)	string
Specifies which deformation algorithm the sculpt object should use. The choices are: flip | project | stretch. The default is stretch. When queried, this flag returns a string.
insideMode(im)	string
Specifies how the deformation algorithm deals with points that are inside the sculpting primitve. The choices are: ring | even. The default is even. When queried, this flag returns a string. Ring mode will tend to produce a contour like ring of points around the sculpt object as it passes through an object while even mode will try to spread the points out as evenly as possible across the surface of the sculpt object.
maxDisplacement(mxd)	linear
Defines the maximum amount the sculpt object may move a point on an object which it is deforming. Default is 1.0. When queried, this flag returns a float.
dropoffDistance(dds)	linear
Specifies the distance from the surface of the sculpt object at which the sculpt object produces no deformation effect. Default is 1.0. When queried, this flag returns a float.
dropoffType(drt)	string
Specifies how the deformation effect drops off from maximum effect at the surface of the sculpt object to no effect at dropoff distance limit. Valid values are: linear | none. Default is linear. When queried, this flag returns a string.
objectCentered(oc)	boolean
Places the sculpt and locator in the center of the bounding box of the selected object(s) or components. Default is off which centers the sculptor and locator at the origin.
groupWithLocator(gwl)	boolean
Groups the sculptor and its locator together under a single transform. Default is off.
sculptTool(st)	string
Use the specified NURBS object as the sculpt tool instead of the default implicit sphere.

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.polyPlane(w=24,h=24,sx=20,sy=20)
# Deforms whatever is currently on the selection list
cmds.sculpt()
# Increase the effect of the deformation
cmds.sculpt( 'sculpt1', edit=True, maxDisplacement=3.0 )
# Try another faster deformation mode
cmds.sculpt( 'sculpt1', edit=True, mode='flip', insideMode='ring' )