polyUVSet

Go to: Synopsis. Return value. Keywords. Related. Flags. MEL examples.

Synopsis

polyUVSet [-allUVSets] [-allUVSetsIndices] [-allUVSetsWithCount] [-copy] [-create] [-currentLastUVSet] [-currentPerInstanceUVSet] [-currentUVSet] [-delete] [-newUVSet string] [-perInstance boolean] [-projections] [-rename] [-shareInstances] [-unshared] [-uvSet string]

polyUVSet is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Keywords

Related

Flags

Long name (short name)	Argument types	Properties
-allUVSets(-auv)
This flag when used in in a query will return a list of all of the uv set names
-allUVSetsIndices(-uvn)
This flag when queried will return a list of the logical plug indices of all the uv sets in the sparse uv set array.
-allUVSetsWithCount(-awc)
This flag when used in a query will return a list of all of the uv set family names, with a count appended to the perInstance sets indicating the number of instances in the uv set shared by the specified or selected shape.
-copy(-cp)
This flag when used will result in the copying of the uv set corresponding to name specified with the uvSet flag to the uvset corresponding to the name specified with the newUVSet flag
-create(-cr)
This flag when used will result in the creation of an empty uv set corresponding to the name specified with the uvSet flag. If a uvSet with that name already exists, then no new uv set will be created.
-currentLastUVSet(-luv)
This flag when used will set the current uv set that the object needs to work on, to be the last uv set added to the object. If no uv set exists for the object, then no uv set name will be returned.
-currentPerInstanceUVSet(-cpi)
This is a query-only flag for use when the current uv set is a per-instance uv set family. This returns the member of the set family that corresponds to the currently select instance.
-currentUVSet(-cuv)
This flag when used will set the current uv set that the object needs to work on, to be the uv set corresponding to the name specified with the uvSet flag. This does require that a uvSet with the specified name exist. When queried, this returns the current uv set.
-delete(-d)
This flag when used will result in the deletion of the uv set corresponding to the name specified with the uvSet flag.
-newUVSet(-nuv)	string
Specifies the name that the uv set corresponding to the name specified with the uvSet flag, needs to be renamed to.
-perInstance(-pi)	boolean
This flag can be used in conjunction with the create flag to indicate whether or not the uv set is per-instance. When you create a per-instance uv set, the set will be applied as shared between all selected instances of the shape unless the unshared flag is used. The perInstance flag can be used in query mode with the currentUVSet or allUVSets flag to indicate that the set family names (i.e. not containing instance identifiers) will be returned by the query. In query mode, this flag can accept a value.
-projections(-pr)
This flag when used in a query will return a list of polygon uv projection node names. The order of the list is from most-recently-applied to least-recently-applied.
-rename(-rn)
This flag when used will result in the renaming of the uv set corresponding to the name specified with the uvSet flag to the name specified using the newUVSet flag.
-shareInstances(-si)
This flag is used to modify the sharing of per-instance uv sets within a given uv set family so that all selected instances share the specified set. In query mode, it returns a list of the instances that share the set specified by the uvSet flag.
-unshared(-us)
This flag can be used in conjunction with the create and perInstance flags to indicate that the newly created per-instance set should be created with a separate set per instance.
-uvSet(-uvs)	string
Specifies the name of the uv set that this command needs to work on. This flag has to be specified for this command to do anything meaningful other than query the current uv set. In query mode, this flag needs a value.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// To set the current uv set to be "map2".
polyUVSet -currentUVSet -uvSet "map2";
// To set the current uv set to the last uv set added to an object.
polyUVSet -currentLastUVSet;
// To query the current uv set.
polyUVSet -q -currentUVSet;
// To rename a currently existing uv set from "map3" to "map4".
polyUVSet -rename -uvSet "map3" -newUVSet "map4";
// Rename the current uv set (if any) to "map4".
polyUVSet -rename -newUVSet "map4";
// To delete a currently existing uv set "map3".
polyUVSet -delete -uvSet "map3";
// To delete the current uv set (if any)
polyUVSet -delete;
// Copy values of uvset "map1" to "map2"
polyUVSet -copy -uvSet "map1" -nuv "map2";
// Copy values of the current uvset to "map2"
polyUVSet -copy -nuv "map2";
// Make a copy of "map1" to a new uvset. The
// name of which is automatically generated and returned.
polyUVSet -copy -uvSet "map1";
// Create a new empty uv set
polyUVSet -create -uvSet "newMap";
// Create a new empty uv set with a generate new name
// The newly generated name is returned.
polyUVSet -create;
// To query all of the uv sets
polyUVSet -q -allUVSets;
// To query the logical indices of the uv sets in the
// node's uv set array
string $node = "plg";
int $indices[] = `polyUVSet -q -allUVSetsIndices $node`;
for( $i in $indices )
{
	string $name = `getAttr ($node+".uvSet["+$i+"].uvSetName")`;
	print( "Found uv set called " + $name + "\n" );
}
// To create a new per-instance uv set named "myMap"
polyUVSet -create -perInstance 1 -uvSet myMap;