polyPlanarProjection

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

Synopsis

polyPlanarProjection([caching=boolean], [constructionHistory=boolean], [createNewMap=boolean], [imageCenter=[float, float]], [imageCenterX=float], [imageCenterY=float], [imageScale=[float, float]], [imageScaleU=float], [imageScaleV=float], [insertBeforeDeformers=boolean], [mapDirection=string], [name=string], [nodeState=int], [projectionCenter=[linear, linear, linear]], [projectionCenterX=linear], [projectionCenterY=linear], [projectionCenterZ=linear], [projectionScale=[linear, linear]], [projectionScaleU=linear], [projectionScaleV=linear], [rotate=[angle, angle, angle]], [rotateX=angle], [rotateY=angle], [rotateZ=angle], [rotationAngle=angle], [worldSpace=boolean])

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

polyPlanarProjection is undoable, queryable, and editable.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
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 "off". Q: When queried, this flag returns an int.
mapDirection(md)	string
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.
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.
projectionCenter(pc)	[linear, linear, linear]
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
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
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
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.
imageCenter(ic)	[float, float]
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
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
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.
rotate(ro)	[angle, angle, angle]
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
This flag specifies X mapping rotate angle. C: Default is 0.0. Q: When queried, this flag returns a float[3].
rotateY(ry)	angle
This flag specifies Y mapping rotate angle. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateZ(rz)	angle
This flag specifies Z mapping rotate angle. C: Default is 0.0. Q: When queried, this flag returns a float.
projectionScale(ps)	[linear, linear]
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].
projectionScaleU(psu)	linear
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.
projectionScaleV(psv)	linear
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.
imageScale(imageScale)	[float, float]
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
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
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.
rotationAngle(ra)	angle
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.
createNewMap(cm)	boolean
This flag when set true will create a new map with a the name passed in, if the map does not already exist.
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.polyPlane( n='plane', h=20, w=20 )

# Create a lambert node.
cmds.shadingNode( 'lambert', n= 'myLambert', asShader=True )
cmds.sets( renderable=True, noSurfaceShader=True, empty=True, name='myLambertSG' )
cmds.connectAttr( 'myLambert.outColor', 'myLambertSG.surfaceShader', f=True )

# Create a texture checker.
cmds.shadingNode( 'checker', asTexture=True )
cmds.shadingNode( 'place2dTexture', asUtility=True )
cmds.connectAttr( 'place2dTexture1.outUV', 'checker1.uv' )

# Assign the texture the the lambert node.
cmds.connectAttr( 'checker1.outColor', 'myLambert.color', f=True )

# Set the textured display mode.
currentPanel = cmds.getPanel(withFocus= True)
if currentPanel != '':
        cmds.modelEditor(currentPanel, edit=True, da='smoothShaded', displayTextures=True, dl='default')

# Assign the lambert shader to all facets of the plane.
cmds.sets('planeShape.f[0:99]', edit=True, forceElement= 'myLambertSG' )

# 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.
cmds.polyPlanarProjection( 'plane.f[0:49]', rx=90, ra=45.0, pc= (0, 0, 0), imageScale=(0.5, 0.5))

# Set the wireframe display mode.
currentPanel = cmds.getPanel(withFocus= True)
if currentPanel != '':
        cmds.modelEditor(currentPanel, edit=True, da='wireframe')