pymel.core.modeling.polyPlanarProjection¶

polyPlanarProjection(*args, **kwargs)¶

TpolyProjCmdBase is a base class for the command to create a mapping on the selected polygonal 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.

Flags:

Long Name / Short Name		Argument Types	Properties
caching / cch		bool
	Toggle caching for all attributes so that no recomputation is needed
constructionHistory / ch		bool
	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
	This flag when set true will create a new map with a the name passed in, if the map does not already exist.
frozen / fzn		bool
imageCenter / ic		float, float
	The center point of the 2D model layout. Default:0.5, 0.5
imageCenterX / icx		float
	Image center X coord.
imageCenterY / icy		float
	Image center Y coord.
imageScale / imageScale		float, float
	Specifies the UV scale : Enlarges or reduces the 2D version of the model in U or V space relative to the 2D centerpoint. Default:1.0, 1.0
imageScaleU / isu		float
	The the U scale : Enlarges or reduces the 2D version of the model in U space relative to the 2D centerpoint.
imageScaleV / isv		float
	The V scale : Enlarges or reduces the 2D version of the model in V space relative to the 2D centerpoint.
insertBeforeDeformers / ibd		bool
	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		bool
	True means keep any image ratio
mapDirection / md		unicode
	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		unicode
	Give a name to the resulting node.
nodeState / nds		int
	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-Blockingwill reset back to Blocking. The Normaland Blockingcases apply to all nodes, while HasNoEffectis node specific; many nodes do not support this option. Plug-ins store state in the MPxNode::stateattribute. Anyone can set it or check this attribute. Additional details about each of these 3 states follow. StateDescriptionNormalThe normal node state. This is the default.HasNoEffectThe HasNoEffectoption (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. Its typical to implement support for the HasNoEffectstate in the nodes 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. BlockingThis is implemented in the depend node base class and applies to all nodes. Blockingis 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 Blockingthe 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 wont evaluate after that. Note that a blocked node will still respond to getAttrrequests but a getAttron a downstream node will not reevaluate the blocked node. Setting the root transform of a hierarchy to Blockingwont automatically influence child transforms in the hierarchy. To do this, youd need to explicitly set all child nodes to the Blockingstate. 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
perInstance / pi		bool
	True if the new map is per-instance, otherwise it is shared.
projectionCenter / pc		float, float, float
	The point on the object that will be the center of the projection. Default:0.0, 0.0, 0.0
projectionCenterX / pcx		float
	Projection center X coord.
projectionCenterY / pcy		float
	Projection center Y coord.
projectionCenterZ / pcz		float
	Projection center Z coord.
projectionHeight / ph		float
	The height of the map relative to the 3D projection axis.
projectionHorizontalSweep / phs		float
	The angle swept horizontally by the projection. The range is [0, 360].
projectionScale / ps		float, float
	The width and the height of the map relative to the 3D projection axis. Default:1.0, 1.0
projectionScaleU / psu		float
projectionScaleV / psv		float
radius / r		float
rotate / ro		float, float, float
	The mapping rotate angles. Default:0.0, 0.0, 0.0
rotateX / rx		float
	X mapping rotate angle.
rotateY / ry		float
	Y mapping rotate angle.
rotateZ / rz		float
	Z mapping rotate angle.
rotationAngle / ra		float
	The angle for the rotation. When the angle is positive, then the map rotates counterclockwise on the mapped model; if negative, the map rotates clockwise. Default:0.0
seamCorrect / sc		bool
	This flag specifies to perform a seam correction on the mapped faces. Common poly modifier operation flags
smartFit / sf		bool
	True means use the smart fit algorithm
worldSpace / ws		bool
	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 have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.polyPlanarProjection

Example:

import pymel.core as pm

# Create a plane with default UVs.
pm.polyPlane( n='plane', h=20, w=20 )

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

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

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

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

# Assign the lambert shader to all facets of the plane.
pm.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.
pm.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 = pm.getPanel(withFocus= True)
if currentPanel != '':
        pm.modelEditor(currentPanel, edit=True, da='wireframe')