polyAutoProjection

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

Synopsis

polyAutoProjection([caching=boolean], [constructionHistory=boolean], [createNewMap=boolean], [insertBeforeDeformers=boolean], [layout=int], [layoutMethod=int], [name=string], [nodeState=int], [optimize=int], [percentageSpace=float], [pivot=[linear, linear, linear]], [pivotX=linear], [pivotY=linear], [pivotZ=linear], [planes=int], [projectBothDirections=boolean], [rotate=[angle, angle, angle]], [rotateX=angle], [rotateY=angle], [rotateZ=angle], [scale=[float, float, float]], [scaleMode=int], [scaleX=float], [scaleY=float], [scaleZ=float], [skipIntersect=boolean], [translate=[linear, linear, linear]], [translateX=linear], [translateY=linear], [translateZ=linear], [uvSetName=string], [worldSpace=boolean])

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

polyAutoProjection 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
planes(p)	int
Number of intermediate projections used. Valid numbers are 4, 5, 6, 8, and 12. C: Default is 6.
optimize(o)	int
Use two different flavors for the cut generation. 0 Every face is assigned to the best plane. This optimizes the map distortion. 1 Small UV pieces are incorporated into larger ones, when the extra distortion introduced is reasonable. This tends to produce fewer UV pieces.
skipIntersect(si)	boolean
When on, self intersection of UV pieces are not tested. This makes the projection faster and produces fewer pieces, but may lead to overlaps in UV space.
scaleMode(sc)	int
How to scale the pieces, after projections: 0 No scale is applied. 1 Uniform scale to fit in unit square. 2 Non proportional scale to fit in unit square.
layout(l)	int
What layout algorithm should be used: 0 UV pieces are set to no layout. 1 UV pieces are aligned along the U axis. 2 UV pieces are moved in a square shape.
percentageSpace(ps)	float
When layout is set to square, this value is a percentage of the texture area which is added around each UV piece. It can be used to ensure each UV piece uses different pixels in the texture. Maximum value is 5 percent.
createNewMap(cm)	boolean
Create a new UV set, as opposed to editing the current one, or the one given by the -uvSetName flag.
uvSetName(uvs)	string
Specifies the name of the UV set to edit uvs on. If not specified will use the current UV set if it exists. When createNewMap is on, the name is used to generate a new unique UV set name.
worldSpace(ws)	boolean
This flag specifies which reference to use. If "on" : all geometrical values are taken in world reference. If "off" : all geometrical values are taken in object reference. C: Default is "on". Q: When queried, this flag returns an integer.
projectBothDirections(pb)	boolean
This flag specifies which reference to use. If "on" : projections are mirrored on directly opposite faces. If "off" : projections are not mirrored on opposite faces. C: Default is "off". Q: When queried, this flag returns an integer.
Global Values
translate(t)	[linear, linear, linear]
This flag specifies the translation vector. C: Default is 0.0 0.0 0.0. Q: When queried, this flag returns a float[3].
translateX(tx)	linear
This flag specifies the X translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
translateY(ty)	linear
This flag specifies the Y translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
translateZ(tz)	linear
This flag specifies the Z translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
rotate(ro)	[angle, angle, angle]
This flag specifies the rotation angles around X, Y, Z. C: Default is 0.0 0.0 0.0. Q: When queried, this flag returns a float[3].
rotateX(rx)	angle
This flag specifies the rotation angle around X. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateY(ry)	angle
This flag specifies the rotation angle around Y. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateZ(rz)	angle
This flag specifies the rotation angle around Z. C: Default is 0.0. Q: When queried, this flag returns a float.
scale(s)	[float, float, float]
This flag specifies the scaling vector. C: Default is 1.0 1.0 1.0. Q: When queried, this flag returns a float[3].
scaleX(sx)	float
This flag specifies X for scaling vector. C: Default is 1.0. Q: When queried, this flag returns a float.
scaleY(sy)	float
This flag specifies Y for scaling vector. C: Default is 1.0. Q: When queried, this flag returns a float.
scaleZ(sz)	float
This flag specifies Z for scaling vector. C: Default is 1.0. Q: When queried, this flag returns a float.
pivot(pvt)	[linear, linear, linear]
This flag specifies the pivot for scaling and rotation. C: Default is 0.0 0.0 0.0. Q: When queried, this flag returns a float[3].
pivotX(pvx)	linear
This flag specifies the X pivot for scaling and rotation. C: Default is 0.0. Q: When queried, this flag returns a float.
pivotY(pvy)	linear
This flag specifies the Y pivot for scaling and rotation. C: Default is 0.0. Q: When queried, this flag returns a float.
pivotZ(pvz)	linear
This flag specifies the Z pivot for scaling and rotation. C: Default is 0.0. Q: When queried, this flag returns a float.
layoutMethod(lm)	int
Set which layout method to use: 0 Block Stacking. 1 Shape Stacking.
insertBeforeDeformers(ibd)	boolean
This flag specifies if the projection node should be inserted before or after deformer nodes already applied to the shape. Inserting the projection after the deformer leads to texture swimming during animation and is most often undesirable. C: Default is on.
Common flags
name(n)	string
Give a name to the resulting node.
constructionHistory(ch)	boolean
Turn the construction history on or off (where applicable). If construction history is on then the corresponding node will be inserted into the history chain for the mesh. If construction history is off then the operation will be performed directly on the object. Note: If the object already has construction history then this flag is ignored and the node will always be inserted into the history chain.
caching(cch)	boolean
Toggle caching for all attributes so that no recomputation is needed
nodeState(nds)	int
Defines how to evaluate the node. 0: Normal 1: PassThrough 2: Blocking 3: Internally disabled. Will return to Normal state when enabled 4: Internally disabled. Will return to PassThrough state when enabled 5: Internally disabled. Will return to Blocking state when enabled

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

# Create a plane with default UVs.
cmds.polySphere( n='sph' )

# Automatic projections with 6 planes.
cmds.polyAutoProjection( 'sphShape.f[*]' )