Go to: Synopsis. Return value. Flags. Python 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])

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

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
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.
Advanced flags
caching(cch) boolean createqueryedit
Modifies the node caching mode. See the node documentation for more information.
Note: For advanced users only.
nodeState(nds) int createqueryedit
Modifies the node state. See the node documentation for more information.
Note: For advanced users only.
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 cube
mel.eval( "createSubdCubeProc" )

# Layout all UVs in the texture plane.
cmds.subdPlanarProjection( 'subdivCube1.smf[*][*]',  rx=90, ra=45.0, pc= (0, 0, 0), imageScale=(0.5, 0.5))