Go to: Synopsis. Return value. Keywords. Related. Flags. Python examples.
polyUVSet([allUVSets=boolean], [allUVSetsIndices=boolean], [allUVSetsWithCount=boolean], [copy=boolean], [create=boolean], [currentLastUVSet=boolean], [currentPerInstanceUVSet=boolean], [currentUVSet=boolean], [delete=boolean], [newUVSet=string], [perInstance=boolean], [projections=boolean], [rename=boolean], [shareInstances=boolean], [unshared=boolean], [uvSet=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
polyUVSet is undoable, queryable, and editable.
Command to do the following to uv sets:
- delete an existing uv set.
- rename an existing uv set.
- create a new empty uv set.
- copy the values from one uv set to a another
pre-existing uv set.
- set the current uv set to a pre-existing uv set.
- modify sharing between instances of per-instance uv sets
- query the current uv set.
- set the current uv set to the last uv set added to an object.
- query the names of all uv sets.
boolean | Success or Failure. |
In query mode, return type is based on queried flag.
poly, uvSet, currentUVSet, renameUVSet, deleteUVSet, copyUVSet, createUVSet
polyClipboard, polyCylindricalProjection, polyEditUV, polyForceUV, polyMapCut, polyMapDel, polyMapSew, polyMoveFacetUV, polyMoveUV, polyPlanarProjection, polyProjection, polySphericalProjection, untangleUV
allUVSets, allUVSetsIndices, allUVSetsWithCount, copy, create, currentLastUVSet, currentPerInstanceUVSet, currentUVSet, delete, newUVSet, perInstance, projections, rename, shareInstances, unshared, uvSet
Long name (short name) |
Argument types |
Properties |
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.
|
|
currentUVSet(cuv)
|
boolean
|
|
|
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.
|
|
currentLastUVSet(luv)
|
boolean
|
|
|
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.
|
|
allUVSets(auv)
|
boolean
|
|
|
This flag when used in in a query will return a list of all
of the uv set names
|
|
allUVSetsIndices(uvn)
|
boolean
|
|
|
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)
|
boolean
|
|
|
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.
|
|
rename(rn)
|
boolean
|
|
|
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.
|
|
newUVSet(nuv)
|
string
|
|
|
Specifies the name that the uv set corresponding to the name specified with
the uvSet flag, needs to be renamed to.
|
|
delete(d)
|
boolean
|
|
|
This flag when used will result in the deletion of the uv set corresponding
to the name specified with the uvSet flag.
|
|
copy(cp)
|
boolean
|
|
|
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)
|
boolean
|
|
|
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.
|
|
projections(pr)
|
boolean
|
|
|
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.
|
|
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.
|
|
unshared(us)
|
boolean
|
|
|
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.
|
|
shareInstances(si)
|
boolean
|
|
|
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.
|
|
currentPerInstanceUVSet(cpi)
|
boolean
|
|
|
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.
|
|
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 have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
# start with poly object
cmds.polySphere(n='plg', cuv=1, r=10.0)
# Make a copy of "map1" to a new uvset. The
# name of which is automatically generated and returned.
cmds.polyUVSet( copy=True, uvSet='map1' )
# Create a new empty uv set
cmds.polyUVSet( create=True, uvSet='map2' )
# To set the current uv set to be "map2".
cmds.polyUVSet( currentUVSet=True, uvSet='map2')
# To set the current uv set to the last uv set added to an object.
cmds.polyUVSet( currentLastUVSet=True )
# To query the current uv set.
cmds.polyUVSet( query=True, currentUVSet=True )
# To rename a currently existing uv set from "map2" to "map3".
cmds.polyUVSet(rename=True, newUVSet='map3', uvSet= 'map2')
# Rename the current uv set (if any) to "map4".
cmds.polyUVSet(rename=True, newUVSet='map4' )
# To delete a currently existing uv set "map4".
cmds.polyUVSet( delete=True, uvSet='map4')
# To delete the current uv set (if any)
cmds.polyUVSet( delete=True )
# Copy values of uvset "map1" to "map2"
cmds.polyUVSet( copy=True, nuv='map2', uvSet='map1' )
# Copy values of the current uvset to "map2"
cmds.polyUVSet( copy=True, nuv='map2' )
# Create a new empty uv set with a generate new name
# The newly generated name is returned.
cmds.polyUVSet( create=True )
# To query all of the uv sets
cmds.polyUVSet( query=True, allUVSets=True )
# To query the logical indices of the uv sets in the
# uv set array of the node
node = "plg"
indices = cmds.polyUVSet(node, query=True, allUVSetsIndices=True)
for i in indices[:]:
name = cmds.getAttr(node+".uvSet["+str(i)+"].uvSetName")
print("Found uv set called " + name )
# To create a new per-instance uv set named "myMap"
cmds.polyUVSet(create=True,perInstance=True,uvSet='myMap');