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

Synopsis

subdPlanarProjection [-caching boolean] [-constructionHistory boolean] [-createNewMap boolean] [-imageCenter float float] [-imageCenterX float] [-imageCenterY float] [-imageScale float float] [-imageScaleU float] [-imageScaleV float] [-insertBeforeDeformers boolean] [-keepImageRatio boolean] [-mapDirection string] [-name string] [-nodeState int] [-projectionCenter linear linear linear] [-projectionCenterX linear] [-projectionCenterY linear] [-projectionCenterZ linear] [-projectionHeight linear] [-projectionScale linear linear] [-projectionWidth linear] [-rotate angle angle angle] [-rotateX angle] [-rotateY angle] [-rotateZ angle] [-rotationAngle angle] [-smartFit boolean] [-worldSpace boolean]

subdPlanarProjection is undoable, queryable, and editable.

TsubProjCmdBase is a base class for the command to create a mapping on the selected subdivision faces. Projects a map onto an object, using an orthogonal projection. The piece of the map defined from isu, isv, icx, icy area, is placed at pcx, pcy, pcz location.

Return value

stringThe node name.

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

Flags

caching, constructionHistory, createNewMap, imageCenter, imageCenterX, imageCenterY, imageScale, imageScaleU, imageScaleV, insertBeforeDeformers, keepImageRatio, mapDirection, name, nodeState, projectionCenter, projectionCenterX, projectionCenterY, projectionCenterZ, projectionHeight, projectionScale, projectionWidth, rotate, rotateX, rotateY, rotateZ, rotationAngle, smartFit, worldSpace
Long name (short name) Argument types Properties
-caching(-cch) boolean createqueryedit
Toggle caching for all attributes so that no recomputation is needed
-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
Common flags
-constructionHistory(-ch) boolean create
Turn the construction history on or off.
-createNewMap(-cm) boolean createqueryedit
This flag when set true will create a new map with a the name passed in, if the map does not already exist.
-imageCenter(-ic2) float float createqueryedit
This flag specifies the center point of the 2D model layout.
C: Default is 0.5 0.5.
Q: When queried, this flag returns a float[2].
-imageCenterX(-icx) float createqueryedit
This flag specifies X for the center point of the 2D model layout.
C: Default is 0.5.
Q: When queried, this flag returns a float.
-imageCenterY(-icy) float createqueryedit
This flag specifies Y for the center point of the 2D model layout.
C: Default is 0.5.
Q: When queried, this flag returns a float.
-imageScale(-is2) float float createqueryedit
This flag specifies the UV scale : Enlarges or reduces the 2D version of the model in U or V space relative to the 2D centerpoint.
C: Default is 1.0 1.0.
Q: When queried, this flag returns a float[2].
-imageScaleU(-isu) float createqueryedit
This flag specifies the U scale : Enlarges or reduces the 2D version of the model in U space relative to the 2D centerpoint.
C: Default is 1.0.
Q: When queried, this flag returns a float.
-imageScaleV(-isv) float createqueryedit
This flag specifies the V scale : Enlarges or reduces the 2D version of the model in V space relative to the 2D centerpoint.
C: Default is 1.0.
Q: When queried, this flag returns a float.
-insertBeforeDeformers(-ibd) boolean create
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.
-keepImageRatio(-kir) boolean create
True means keep any image ratio
-mapDirection(-md) string create
This flag specifies the mapping direction.
'x', 'y' and 'z' projects the map along the corresponding axis.
'c' projects along the current camera viewing direction.
'p' does perspective projection if current camera is perspective.
'b' projects along the best plane fitting the objects selected.
-name(-n) string create
Sets the name of the newly-created node. If it contains namespace path, the new node will be created under the specified namespace; if the namespace does not exist, it will be created.
-projectionCenter(-pc) linear linear linear createqueryedit
This flag specifies the origin point from which the map is projected.
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3].
-projectionCenterX(-pcx) linear createqueryedit
This flag specifies X for the origin point from which the map is projected.
C: Default is 0.0.
Q: When queried, this flag returns a float.
-projectionCenterY(-pcy) linear createqueryedit
This flag specifies Y for the origin point from which the map is projected.
C: Default is 0.0.
Q: When queried, this flag returns a float.
-projectionCenterZ(-pcz) linear createqueryedit
This flag specifies Z for the origin point from which the map is projected.
C: Default is 0.0.
Q: When queried, this flag returns a float.
-projectionHeight(-ph) linear createqueryedit
This flag specifies the height of the map relative to the 3D projection axis.
C: Default is 1.0
Q: When queried, this flag returns a float.
-projectionScale(-ps) linear linear createqueryedit
This flag specifies the width and the height of the map relative to the 3D projection axis.
C: Default is 1.0 1.0.
Q: When queried, this flag returns a float[2].
-projectionWidth(-pw) linear createqueryedit
This flag specifies the width of the map relative to the 3D projection axis.
C: Default is 1.0
Q: When queried, this flag returns a float.
-rotate(-ro) angle angle angle createqueryedit
This flag specifies the mapping rotate angles.
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 X mapping rotate angle.
C: Default is 0.0.
Q: When queried, this flag returns a float[3].
-rotateY(-ry) angle createqueryedit
This flag specifies Y mapping rotate angle.
C: Default is 0.0.
Q: When queried, this flag returns a float.
-rotateZ(-rz) angle createqueryedit
This flag specifies Z mapping rotate angle.
C: Default is 0.0.
Q: When queried, this flag returns a float.
-rotationAngle(-ra) angle createqueryedit
This flag specifies the rotation angle in the mapping space. When the angle is positive, then the map rotates counterclockwise on the mapped model, whereas when it is negative then the map rotates lockwise on the mapped model.
C: Default is 10.0.
Q: When queried, this flag returns a float.
-smartFit(-sf) boolean create
True means use the smart fit algorithm
-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.

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 be used more than once in a command.

MEL examples

// Create a cube
createSubdCube;

// Replace default UVs on half of the plane :
// Rotates projection around X, rotate the map of 45 degrees,
// and reduces of half the projected map.
subdPlanarProjection -rx 90 -ra 45.0 -pc 0 0 0 -is 0.5 0.5 "subdivCube1.smf[*][*]";