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.

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

Return value

stringThe node name.

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

Flags

caching, constructionHistory, createNewMap, insertBeforeDeformers, layout, layoutMethod, name, nodeState, optimize, percentageSpace, pivot, pivotX, pivotY, pivotZ, planes, projectBothDirections, rotate, rotateX, rotateY, rotateZ, scale, scaleMode, scaleX, scaleY, scaleZ, skipIntersect, translate, translateX, translateY, translateZ, uvSetName, worldSpace
Long name (short name) Argument types Properties
Common poly modifier operation flags
caching(cch) boolean createqueryedit
Toggle caching for all attributes so that no recomputation is needed
constructionHistory(ch) boolean createquery
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) boolean create
Set to true if a new map should be created
insertBeforeDeformers(ibd) boolean create
Set to true if the new node created should inserted before any deformer nodes.
layout(l) int createqueryedit
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.
name(n) string create
Give a name to the resulting node.
nodeState(nds) int createqueryedit

Maya dependency nodes have 6 possible states. The Normal (0), HasNoEffect (1), and Blocking (2) states can be used to alter how the graph is evaluated.

The Waiting-Normal (3), Waiting-HasNoEffect (4), Waiting-Blocking (5) are for internal use only. They temporarily shut off parts of the graph during interaction (e.g., manipulation). The understanding is that once the operation is done, the state will be reset appropriately, e.g. Waiting-Blocking will reset back to Blocking.

The Normal and Blocking cases apply to all nodes, while HasNoEffect is node specific; many nodes do not support this option. Plug-ins store state in the MPxNode::state attribute. Anyone can set it or check this attribute. Additional details about each of these 3 states follow.

State Description
Normal The normal node state. This is the default.
HasNoEffect

The HasNoEffect option (a.k.a. pass-through), is used in cases where there is an operation on an input producing an output of the same data type. Nearly all deformers support this state, as do a few other nodes. As stated earlier, it is not supported by all nodes.

It’s typical to implement support for the HasNoEffect state in the node’s compute method and to perform appropriate operations. Plug-ins can also support HasNoEffect.

The usual implementation of this state is to copy the input directly to the matching output without applying the algorithm in the node. For deformers, applying this state leaves the input geometry undeformed on the output.

Blocking

This is implemented in the depend node base class and applies to all nodes. Blocking is applied during the evaluation phase to connections. An evaluation request to a blocked connection will return as failures, causing the destination plug to retain its current value. Dirty propagation is indirectly affected by this state since blocked connections are never cleaned.

When a node is set to Blocking the behavior is supposed to be the same as if all outgoing connections were broken. As long as nobody requests evaluation of the blocked node directly it won’t evaluate after that. Note that a blocked node will still respond to getAttr requests but a getAttr on a downstream node will not reevaluate the blocked node.

Setting the root transform of a hierarchy to Blocking won’t automatically influence child transforms in the hierarchy. To do this, you’d need to explicitly set all child nodes to the Blocking state.

For example, to set all child transforms to Blocking, you could use the following script.


import maya.cmds as cmds
def blockTree(root):
nodesToBlock = []
for node in {child:1 for child in cmds.listRelatives( root, path=True, allDescendents=True )}.keys():
nodesToBlock += cmds.listConnections(node, source=True, destination=True )
for node in {source:1 for source in nodesToBlock}.keys():
cmds.setAttr( '%s.nodeState' % node, 2 )

Applying this script would continue to draw objects but things would not be animated.


Default: kdnNormal
optimize(o) int createqueryedit
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 createqueryedit
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.
planes(p) int createqueryedit
Number of intermediate projections used. Valid numbers are 4, 5, 6, 8, and 12.
C: Default is 6.
projectBothDirections(pb) boolean createqueryedit
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.
scaleMode(sc) int createqueryedit
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.
skipIntersect(si) boolean createqueryedit
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.
uvSetName(uvs) string create
Name of the UV set to be created
worldSpace(ws) boolean createqueryedit
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 off.
Q: When queried, this flag returns an int.
Global Values
layoutMethod(lm) int createqueryedit
Set which layout method to use:
0 Block Stacking.
1 Shape Stacking.
pivot(pvt) [linear, linear, linear] createqueryedit
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 createqueryedit
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 createqueryedit
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 createqueryedit
This flag specifies the Z pivot for scaling and rotation.
C: Default is 0.0.
Q: When queried, this flag returns a float.
rotate(ro) [angle, angle, angle] createqueryedit
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 createqueryedit
This flag specifies the rotation angle around X.
C: Default is 0.0.
Q: When queried, this flag returns a float.
rotateY(ry) angle createqueryedit
This flag specifies the rotation angle around Y.
C: Default is 0.0.
Q: When queried, this flag returns a float.
rotateZ(rz) angle createqueryedit
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] createqueryedit
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 createqueryedit
This flag specifies X for scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.
scaleY(sy) float createqueryedit
This flag specifies Y for scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.
scaleZ(sz) float createqueryedit
This flag specifies Z for scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.
translate(t) [linear, linear, linear] createqueryedit
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 createqueryedit
This flag specifies the X translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.
translateY(ty) linear createqueryedit
This flag specifies the Y translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.
translateZ(tz) linear createqueryedit
This flag specifies the Z translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

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[*]' )