deformerWeights is undoable, queryable, and editable.
Command to import and export deformer weights to and from a simple XML
file. The weight data is stored in a per-vertex fashion along with a
"point cloud" corresponding to the vertices from the geometry input to
the deformer.
For example a cluster deformer would have the following information:
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-attribute(-at)
|
string
|
|
|
Specify the long name of deformer attribute that should be imported/exported along with the deformerWeights. i.e. -at "envelope" -at "skinningMethod" etc.. No warning or error is given if a specified attribute does not exist on a particular deformer, making it possible to use this command with multiple deformers without aborting or slowing down the import/export process. Currently supports numeric attributes and matrix attributes
|
|
-defaultValue(-dv)
|
float
|
|
|
Manually set the default value. Default values are values that are not written to file. For example, for blendShapes the default value is automatically set to 1.0 and these values are not written to disk. For skinClusters the value is 0.0. If all weights should be forced to be written to disk, set a defaultValue = -1.0.
|
|
-deformer(-df)
|
string
|
|
|
Specify the deformer whose weights should be exported or imported. If a pattern is supplied for the deformer
name (i.e: cluster*), only the first deformer that matches the pattern will be imported/exported unless used
in conjunction with the -skip option
|
|
-export(-ex)
|
|
|
|
Export the given deformer
|
|
-format(-fm)
|
string
|
|
|
Specify either "XML" or "JSON" as the file extension to save as.
|
|
-ignoreName(-ig)
|
|
|
|
Ignore the names of the layers on import, just use the order of the layers instead. This can be used when
joint names have been changed. Leaving it on only name that match on import will be write to the deformer.
|
|
-import(-im)
|
|
|
|
Import weights to the specified deformer. See the method flag for details
on how the weights will be mapped to the destination deformer.
|
|
-method(-m)
|
string
|
|
|
Specify the method used to map the weight during import. Valid values are:
"index", "nearest", "barycentric", "bilinear" and "over". The "index" method
uses the vertex index to map the weights onto the object. This is most useful
when the destination object shares the same topology as the exported data.
The "nearest" method finds the nearest vertex in the imported data set and
sets the weight value to that value. This is best used when mapping a higher
resolution mesh to a lower resolution. The "barycentric" and "bilinear" methods
are only supported with polygon mesh exported with -vc/vertexConnections flag.
The "barycentric" method finds the nearest triangle of the input geometry and
rescales the weights at the triangle vertices according to the barycentric
weights to each vertex of the nearest triangle. The "bilinear" method finds the
nearest convex quad of the input geometry and rescales the weights at the quad
vertices according to the bilinear weights to each vertex of the nearest convex
quad. For non-quad polygon, the "bilinear" method will fall back to "barycentric"
method. The "over" method is similar to the "index" method but the weights on the
destination mesh are not cleared prior to mapping, so that unmatched indices
keep their weights intact.
|
|
-path(-p)
|
string
|
|
|
The path to the given file. Default to the current project.
|
|
-positionTolerance(-pt)
|
float
|
|
|
The position tolerance is used to determine the radius of search for the nearest method. This flag is only
used with import.
Defaults to a huge number.
|
|
-remap(-r)
|
string
|
|
|
Remap maps source regular expression to destination format. It maps any name that matches the regular expression (before the semi-colon) to the expression format (after the semi-colon).
For example, -remap "test:(.*);$1" will rename all items in the test namespace to the global namespace. Accepts $1, $2, .., $9 as pattern holders in the expression format.
Remap flag must be used together with import or export. When working with import, the name of the object from the xml file matching the regular expression is remapped to object in scene. When working with export, the name of the object from the scene matching the regular expression is remapped to object in xml file.
|
|
-shape(-sh)
|
string
|
|
|
Specify the source shape. Export will write out all the deformers on the shape node into one file.
If a pattern is supplied for the shape name (i.e: pCylinder*), only the first shape that matches the pattern will
be imported/exported unless used in conjunction with the -skip option.
|
|
-skip(-sk)
|
string
|
|
|
Skip any deformer, shape, or layer that whose name matches the given regular expression string
|
|
-vertexConnections(-vc)
|
|
|
|
Export vertex connection information, which is required for -m/-method "barycentric" and "bilinear". The flag is only used with -ex/-export flag. The vertex connection information is automatically loaded during import if available in xml file.
|
|
-weightPrecision(-wp)
|
uint
|
|
|
Sets the output decimal precision for exported weights. The default value is 3.
|
|
-weightTolerance(-wt)
|
float
|
|
|
The weight tolerance is used to decide if a given weight value is close enough to the default value that it does not need to be included. This flag is only used with export. The default value is .001.
|
|
-worldSpace(-ws)
|
|
|
|
For spatially based association methods (nearest), the position should be based on the world space position
rather then the local object space.
|
|