transferAttributes

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

transferAttributes( object object , [colorBorders=uint], [flipUVs=uint], [matchChoice=uint], [sampleSpace=uint], [searchMethod=uint], [searchScaleX=float], [searchScaleY=float], [searchScaleZ=float], [sourceColorSet=string], [sourceUvSet=string], [sourceUvSpace=string], [targetColorSet=string], [targetUvSet=string], [targetUvSpace=string], [transferColors=uint], [transferNormals=uint], [transferPositions=uint], [transferUVs=uint])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

transferAttributes is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
transferPositions(pos)	uint
A non-zero value indicates vertex position should be sampled, causing the target surface to "wrap" to the source surface(s).
transferNormals(nml)	uint
A non-zero value indicates vertex normals should be sampled and written into user normals on the target surface.
transferUVs(uvs)	uint
Controls UV set transfer. 0 means no UV sets are transferred, 1 means that a single UV set (specified by sourceUVSet and targetUVSet) is transferred, and 2 means that all UV sets are transferred.
sourceUvSet(suv)	string
Specifies the name of a single UV set on the source surface(s) that should be transferred to the target. This value is only used when the operation is configured to transfer a single UV set (see the transferUVs flag).
targetUvSet(tuv)	string
Specifies the name of a single UV set on the target surface that should be receive the sampled UV data. This value is only used when the operation is configured to transfer a single UV set (see the transferUVs flag).
transferColors(col)	uint
Controls color set transfer. 0 means no color sets are transferred, 1 means that a single color set (specified by sourceColorSet and targetColorSet) is transferred, and 2 means that all color sets are transferred.
sourceColorSet(scs)	string
Specifies the name of a single color set on the source surface(s) that should be transferred to the target. This value is only used when the operation is configured to transfer a single color set (see the transferColors flag).
targetColorSet(tcs)	string
Specifies the name of a single color set on the target surface that should be receive the sampled color data. This value is only used when the operation is configured to transfer a single color set (see the transferColors flag).
searchScaleX(ssx)	float
Specifies an optional scale that should be applied to the x-axis of the target model before transferring data. A value of 1.0 (the default) means no scaling; a value of -1.0 would indicate mirroring along the x-axis.
searchScaleY(ssy)	float
Specifies an optional scale that should be applied to the y-axis of the target model before transferring data. A value of 1.0 (the default) means no scaling; a value of -1.0 would indicate mirroring along the y-axis.
searchScaleZ(ssz)	float
Specifies an optional scale that should be applied to the z-axis of the target model before transferring data. A value of 1.0 (the default) means no scaling; a value of -1.0 would indicate mirroring along the z-axis.
flipUVs(fuv)	uint
Controls how sampled UV data is flipped before being transferred to the target. 0 means no flipping; 1 means UV data is flipped in the U direction; 2 means UV data is flipped in the V direction; and 3 means it is flipped in both directions. In conjunction with mirroring, this allows the creation of symmetric UV mappings (e.g. the left hand side of the character on one side of the UV map, the right hand side on the other).
colorBorders(clb)	uint
Controls whether color borders are preserved when transferring color data. If this is non-zero, any color borders will be mapped onto the nearest edge on the target geometry. 0 means any color borders will be smoothly blended onto the vertices of the target geometry.
sampleSpace(spa)	uint
Selects which space the attribute transfer is performed in. 0 is world space, 1 is model space, 4 is component-based, 5 is topology-based. The default is world space.
searchMethod(sm)	uint
Specifies which search method to use when correlating points. 0 is closest along normal, 3 is closest to point. The default is closest to point.
sourceUvSpace(sus)	string
Specifies the name of the UV set on the source surface(s) that should be used as the transfer space. This value is only used when the operation is configured to transfer attributes in UV space.
targetUvSpace(tus)	string
Specifies the name of the UV set on the target surface( that should be used as the transfer space. This value is only used when the operation is configured to transfer attributes in UV space.
matchChoice(mch)	uint
When using topological component matching, selects between possible matches. If the meshes involved in the transfer operation have symmetries in their topologies, there may be more than one possible topological match. Maya scores the possible matches (by comparing the shapes of the meshes) and assigns them an index, starting at zero. Match zero, the default, is considered the best, but in the event that Maya chooses the wrong one, changing this value will allow the user to explore the other matches.

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.

Python examples

import maya.cmds as cmds

# Transfer all UV and color sets from pCube1 onto pSphere1
cmds.transferAttributes( 'pCube1', 'pSphere1', transferUVs=2, transferColors=2 )