pymel.core.animation.sculpt

sculpt(*args, **kwargs)

This command creates/edits/queries a sculpt object deformer. By default for creation mode an implicit sphere will be used as the sculpting object if no sculpt tool is specified. The name of the created/edited object is returned.

Flags:

Long name (short name)		Argument Types	Properties
after (af)		bool
	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)		bool
	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.
before (bf)		bool
	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).
deformerTools (dt)		bool
	Returns the name of the deformer tool objects (if any) as string string ...
dropoffDistance (dds)		float
	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)		unicode
	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.
exclusive (ex)		unicode
	Puts the deformation set in a deform partition.
frontOfChain (foc)		bool
	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).
geometry (g)		unicode
	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)		bool
	Complements the -geometry flag in query mode. Returns the multi index of each geometry.
groupWithLocator (gwl)		bool
	Groups the sculptor and its locator together under a single transform. Default is off.
ignoreSelected (ignoreSelected)		bool
	Tells the command to not deform objects on the current selection list
insideMode (im)		unicode
	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)		float
	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.
mode (m)		unicode
	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.
name (n)		unicode
	Used to specify the name of the node being created
objectCentered (oc)		bool
	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.
parallel (par)		bool
	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).
prune (pr)		bool
	Removes any points not being deformed by the deformer in its current configuration from the deformer set.
remove (rm)		bool
	Specifies that objects listed after the -g flag should be removed from this deformer.
sculptTool (st)		unicode
	Use the specified NURBS object as the sculpt tool instead of the default implicit sphere.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
split (sp)		bool
	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).

Derived from mel command maya.cmds.sculpt

Example:

import pymel.core as pm

pm.polyPlane(w=24,h=24,sx=20,sy=20)
# Result: [nt.Transform(u'pPlane1'), nt.PolyPlane(u'polyPlane1')] #

# Deforms whatever is currently on the selection list
pm.sculpt()
# Result: [nt.Sculpt(u'sculpt1'), nt.Transform(u'sculptor1'), nt.Transform(u'sculpt1StretchOrigin')] #

# Increase the effect of the deformation
pm.sculpt( 'sculpt1', edit=True, maxDisplacement=3.0 )

# Try another faster deformation mode
pm.sculpt( 'sculpt1', edit=True, mode='flip', insideMode='ring' )