pymel.core.animation.textureDeformer

textureDeformer(*args, **kwargs)

This command creates a texture deformer for the object. The selected objects are the input geometry objects. The deformer node name will be 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 ...
direction (d)		unicode
	Set the deformation direction of texture deformer It can only handle three types: Normal, Handleand Vector. Normaleach vertices use its own normal vector. Handleall vertices use Up vector of the handle. Vectoreach vertices use RGB color vector strings.
envelope (en)		float
	Set the envelope of texture deformer. Envelope determines the percent of deformation. The final result is (color * normal * strength + offset) * envelope
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
includeHiddenSelections (ihs)		bool
	Apply the deformer to any visible and hidden objects in the selection list. Default is false. current selection list
name (n)		unicode
	Used to specify the name of the node being created
offset (o)		float
	Set the offset of texture deformer. Offset plus a translation on the final deformed vertices.
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).
pointSpace (ps)		unicode
	Set the point space of texture deformer. It can only handle three strings: World, Localand UV. Worldmap world space to color space. Localmap local space to color space. UVmap UV space to color space. strings.
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.
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).
strength (s)		float
	Set the strength of texture deformer. Strength determines how strong the object is deformed.
vectorOffset (vo)		float, float, float
	Set the vector offset of texture deformer. Vector offset indicates the offset of the deformation on the vector mode.
vectorSpace (vsp)		unicode
	Set the vector space of texture deformer. It can only handle three strings: Object, Worldand Tangent. Objectuse color vector in object space Worlduse color vector in world space Tangentuse color vector in tangent space strings. Flag can have multiple arguments, passed either as a tuple or a list.
vectorStrength (vs)		float, float, float
	Set the vector strength of texture deformer. Vector strength determines how strong the object is deformed on the vector mode.

Derived from mel command maya.cmds.textureDeformer

Example:

import pymel.core as pm

pm.polySphere(constructionHistory=True, object=True, radius=3.0)
# Result: [nt.Transform(u'pSphere1'), nt.PolySphere(u'polySphere1')] #

# Deforms whatever is currently on the selection list
# and set the attributes value for the deformer node
pm.textureDeformer(envelope=0.8, strength=1.0, offset=1.0, direction="Normal", pointSpace="World")
# Result: [nt.TextureDeformer(u'textureDeformer1'), nt.TextureDeformerHandle(u'textureDeformerHandle1')] #