pymel.core.animation.sculptTarget¶

sculptTarget(*args, **kwargs)¶

This command is used to specify the blend shape target to be modified by the sculpting tools and transform manipulators.

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 the desired behavior then this flag can be used to force the command to place 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 the -after mode is used when adding the new deformer, otherwise the -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 the desired behavior then this flag can be used to force the command to place 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 ...
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.
ignoreSelected / ignoreSelected		bool
	Tells the command to not deform objects on the current selection list
inbetweenWeight / ibw		float
	Specifies the in between target weight of the blend shape node that will be made editable by the sculpting and transform tools.
includeHiddenSelections / ihs		bool
	Apply the deformer to any visible and hidden objects in the selection list. Default is false.
name / n		unicode
	Used to specify the name of the node being created.
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.
regenerate / r		bool
	When this flag is specified a new shape is created for the specified blend shape target, if the shape does not already exist. The name of the new shape is returned.
remove / rm		bool
	Specifies that objects listed after the -g flag should be removed from this deformer.
snapshot / s		int
	This flag should only be used internally to add in-between target. When this flag is specified a snapshot of the shape will be taken for the specified in-between target when it does not exist yet. This flag specifies the base shape index and must be used with the -target and -inbetweenWeight flags, which specify the in- between target.
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).
target / t		int
	Specifies the target index of the blend shape node that will be made editable by the sculpting and transform tools. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.sculptTarget

Example:

::

import pymel.core as pm

# To set the current editable target to target 3 pm.sculptTarget( ‘blendShape1’, e=True, t=3 )

# To set the current editable target to none pm.sculptTarget( ‘blendShape1’, e=True, t=-1 )