pymel.core.modeling.polyAutoProjection

polyAutoProjection(*args, **kwargs)

Projects a map onto an object, using several orthogonal projections simultaneously.

Flags:
Long name (short name) Argument Types Properties
caching (cch) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Toggle caching for all attributes so that no recomputation is needed
constructionHistory (ch) bool ../../../_images/create.gif ../../../_images/query.gif
 

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.

createNewMap (cm) bool ../../../_images/create.gif ../../../_images/query.gif
 
Create a new UV set, as opposed to editing the current one, or the one given by the -uvSetName flag.
insertBeforeDeformers (ibd) bool ../../../_images/create.gif
 

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

layout (l) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.
layoutMethod (lm) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Set which layout method to use: 0 Block Stacking. 1 Shape Stacking.
name (n) unicode ../../../_images/create.gif
 
Give a name to the resulting node.
nodeState (nds) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Defines how to evaluate the node. 0: Normal1: PassThrough2: Blocking3: Internally disabled. Will return to Normal state when enabled4: Internally disabled. Will return to PassThrough state when enabled5: Internally disabled. Will return to Blocking state when enabledFlag can have multiple arguments, passed either as a tuple or a list.

optimize (o) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

percentageSpace (ps) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

pivot (pvt) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the Z pivot for scaling and rotation. C: Default is 0.0. Q: When queried, this flag returns a float.
planes (p) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Number of intermediate projections used. Valid numbers are 4, 5, 6, 8, and 12. C: Default is 6.
projectBothDirections (pb) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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

rotate (ro) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the rotation angle around X. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateY (ry) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the rotation angle around Y. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateZ (rz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the scaling vector. C: Default is 1.0 1.0 1.0. Q: When queried, this flag returns a float[3].
scaleMode (sc) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.
scaleX (sx) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies X for scaling vector. C: Default is 1.0. Q: When queried, this flag returns a float.
scaleY (sy) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies Y for scaling vector. C: Default is 1.0. Q: When queried, this flag returns a float.
scaleZ (sz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies Z for scaling vector. C: Default is 1.0. Q: When queried, this flag returns a float.
skipIntersect (si) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.
translate (t) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the X translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
translateY (ty) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the Y translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
translateZ (tz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the Z translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
uvSetName (uvs) unicode ../../../_images/create.gif ../../../_images/query.gif
 

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) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

Derived from mel command maya.cmds.polyAutoProjection

Example:

import pymel.core as pm

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

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

Previous topic

pymel.core.modeling.polyAppendVertex

Next topic

pymel.core.modeling.polyAverageNormal

Core

Core Modules

Other Modules

This Page