blendShape is undoable, queryable, and editable.
This command creates a blendShape deformer, which blends in specified
amounts of each target shape to the initial base shape.
Each base shape is deformed by its own set of target shapes.
Every target shape has an index that associates it with one of
the shape weight values.In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
-after(-af)
|
|
|
|
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)
|
|
|
|
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.
|
|
-automatic(-at)
|
|
|
|
The -automatic flag is used to specify deformer ordering in a way that
choses between -frontOfChain and -before automatically. If the geometry being
deformed is only affected by invertible deformers, the -frontOfChain mode is used, otherwise
the -before mode is used.
|
|
-before(-bf)
|
|
|
|
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).
|
|
-components(-cmp)
|
|
|
|
Returns the components used by the deformer
|
|
-copyDelta(-cd)
|
uint uint uint
|
|
|
Set the base, source, and destination delta index values.
|
|
-copyInBetweenDelta(-cid)
|
uint uint uint uint
|
|
|
Set the base, target, source, and destination delta index values.
|
|
-copyWeights(-cw) 2023
|
uint uint uint
|
|
|
Copy base, source, and destination weight index values.
|
|
-deformerTools(-dt)
|
|
|
|
Returns the name of the deformer tool objects (if any)
as string string ...
|
|
-envelope(-en)
|
float
|
|
|
Set the envelope value for the deformer, controlling
how much of the total deformation gets applied. Default is 1.0.
|
|
-exclusive(-ex)
|
string
|
|
|
Puts the deformation set in a deform partition.
|
|
-export(-ep)
|
string
|
|
|
Export the shapes to the named file path.
|
|
-exportTarget(-et)
|
int int
|
|
|
Specify the base and target index pairs for the export.
|
|
-flipTarget(-ft)
|
uint uint
|
|
|
Flip the list of base and target pairs.
|
|
-frontOfChain(-foc)
|
|
|
|
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)
|
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)
|
|
|
|
Complements the -geometry flag in query mode. Returns
the multi index of each geometry.
|
|
-ignoreSelected(-is)
|
|
|
|
Tells the command to not deform objects on the
current selection list
|
|
-import(-ip)
|
string
|
|
|
Import the shapes from the named file path.
|
|
-inBetween(-ib)
|
|
|
|
Indicate that the specified target should serve as
an inbetween. An inbetween target is one that serves as an
intermediate target between the base shape and another target.
|
|
-inBetweenIndex(-ibi)
|
uint
|
|
|
Only used with the -rtd/-resetTargetDelta flag to remove delta values
for points in the inbetween target geometry defined by this index.
|
|
-inBetweenType(-ibt)
|
string
|
|
|
Specify if the in-between target to be created is relative to the hero
target or if it is absolute.
If it is relative to hero targets, the in-between target will get any changes made to the hero target.
Valid values are "relative" and "absolute".
This flag should always be used with the -ib/-inBetween and -t/-target flags.
|
|
-includeHiddenSelections(-ihs)
|
|
|
|
Apply the deformer to any visible and hidden objects in the selection list.
Default is false.
|
|
-mergeSource(-mgs)
|
int
|
|
|
List of source indexes for a merge.
|
|
-mergeTarget(-mgt)
|
uint
|
|
|
-mirrorDirection(-md)
|
uint
|
|
|
Mirror direction; 0 = negative, 1 = positive
|
|
-mirrorTarget(-mt)
|
uint uint
|
|
|
Mirror the list of base and target pairs.
|
|
-name(-n)
|
string
|
|
|
Used to specify the name of the node being created.
|
|
-normalizationGroups(-ng)
|
|
|
|
Returns a list of the used normalization group IDs.
|
|
-origin(-o)
|
string
|
|
|
blendShape will be performed with respect to the
world by default. Valid values are "world" and "local". The local flag will cause the blend
shape to be performed with respect to the shape's local
origin.
|
|
-parallel(-par)
|
|
|
|
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)
|
|
|
|
Removes any points not being deformed by the deformer in
its current configuration from the deformer set.
|
|
-remove(-rm)
|
|
|
|
Specifies that objects listed after the -g flag should
be removed from this deformer.
|
|
-resetTargetDelta(-rtd)
|
uint uint
|
|
|
Remove all delta values for points in the target geometry,
including all sequential targets defined by target index.
Parameter list:
- uint: the base object index
- uint: the target index
|
|
-selectedComponents(-cms)
|
|
|
|
Returns the components used by the deformer that are currently selected.
This intersects the current selection with the components affected by the deformer.
|
|
-split(-sp)
|
|
|
|
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).
|
|
-suppressDialog(-sd)
|
|
|
|
Suppress dialog box and run the command as defined by the user.
|
|
-symmetryAxis(-sa)
|
string
|
|
|
Axis for symmetry. Valid values are "X", "Y", and "Z".
|
|
-symmetryEdge(-se)
|
string
|
|
|
One or two symmetry edge names, separated by a ".". See the blendShape node's
symmetryEdge attribute for legal values.
|
|
-symmetrySpace(-ss)
|
uint
|
|
|
Space for symmetry. 0 = Topological, 1 = Object, 2 = UV
|
|
-tangentSpace(-ts)
|
|
|
|
Indicate that the delta of the specified target should be relative to
the tangent space of the surface.
|
|
-target(-t)
|
string uint string float
|
|
|
Set target object as the index target shape for the base shape base
object. The full influence of target shape takes effect when its shape
weight is targetValue.
Parameter list:
- string: the base object
- int: index
- string: the target object
- double: target value
|
|
-topologyCheck(-tc)
|
boolean
|
|
|
Set the state of checking for a topology match between the
shapes being blended. Default is on.
|
|
-transform(-tr)
|
string
|
|
|
Set transform for target, then the deltas will become relative to a post transform. Typically the
best workflow for this option is to choose a joint that is related to the fix you have introduced.
This flag should be used only if the "Deformation order" of blendShape node is "Before".
|
|
-useComponentTags(-uct)
|
|
|
|
When this flag is specified a setup using componentTags will be created.
This means no groupId, groupParts, tweak or objectSet nodes will be
created and connected to the new deformer.
|
|
-weight(-w)
|
uint float
|
|
|
Set the weight value (second parameter) at index (first parameter).
|
|
-weightCount(-wc)
|
uint
|
|
|
Set the number of shape weight values.
|
|