polyPlanarProjection

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

Synopsis

polyPlanarProjection [-constructionHistory boolean] [-createNewMap boolean] [-imageCenter linear linear] [-imageCenterX linear] [-imageCenterY linear] [-imageScale linear linear] [-imageScaleU linear] [-imageScaleV linear] [-insertBeforeDeformers boolean] [-mapDirection x|y|z|c|p|b] [-name string] [-projectionCenter linear linear linear] [-projectionCenterX linear] [-projectionCenterY linear] [-projectionCenterZ linear] [-projectionScale linear linear] [-projectionScaleU linear] [-projectionScaleV linear] [-rotate angle angle angle] [-rotateX angle] [-rotateY linear] [-rotateZ linear] [-rotationAngle angle] [-worldSpace boolean]

polyPlanarProjection is undoable, queryable, and editable.

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. In query mode, this flag needs a value.
-mapDirection(-md)	x|y|z|c|p|b
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]. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-imageCenter(-ic)	linear linear
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]. In query mode, this flag needs a value.
-imageCenterX(-icx)	linear
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. In query mode, this flag needs a value.
-imageCenterY(-icy)	linear
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. In query mode, this flag needs a value.
-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]. In query mode, this flag needs a value.
-rotateX(-rx)	angle
This flag specifies X mapping rotate angle. C: Default is 0.0. Q: When queried, this flag returns a float[3]. In query mode, this flag needs a value.
-rotateY(-ry)	linear
This flag specifies Y mapping rotate angle. C: Default is 0.0. Q: When queried, this flag returns a float. In query mode, this flag needs a value.
-rotateZ(-rz)	linear
This flag specifies Z mapping rotate angle. C: Default is 0.0. Q: When queried, this flag returns a float. In query mode, this flag needs a value.
-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]. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-imageScale(-is)	linear linear
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]. In query mode, this flag needs a value.
-imageScaleU(-isu)	linear
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. In query mode, this flag needs a value.
-imageScaleV(-isv)	linear
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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-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. In query mode, this flag needs a value.
-name(-n)	string
Name the resulting object.
-constructionHistory(-ch)	boolean
Turn the construction history on or off (where applicable). Q: When queried, this flag returns an int. In query mode, this flag needs a value.

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

Return value

Related

MEL examples

// Create a plane with default UVs.
polyPlane -n plane -h 20 -w 20;

// Create a lambert node.
shadingNode -asShader lambert -n myLambert;
sets -renderable true -noSurfaceShader true -empty -name myLambertSG;
connectAttr -f myLambert.outColor myLambertSG.surfaceShader;

// Create a texture checker.
shadingNode -asTexture checker;
shadingNode -asUtility place2dTexture;
connectAttr place2dTexture1.outUV checker1.uv;

// Assign the texture the the lambert node.
connectAttr -f checker1.outColor myLambert.color;

// Set the textured display mode.
if ( `getPanel -to ( eval( "getPanel -withFocus" ) )` ) {
   string $currentPanel = `getPanel -withFocus`;
   modelEditor -edit -da "smoothShaded" -displayTextures on -dl "default" $currentPanel;
}

// Assign the lambert shader to all facets of the plane.
sets -e -forceElement myLambertSG planeShape.f[0:99];

// 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.
polyPlanarProjection -rx 90 -ra 45.0 -pc 0 0 0 -is 0.5 0.5 plane.f[0:49] ;

// Set the wireframe display mode.
if ( `getPanel -to ( eval( "getPanel -withFocus" ) )` ) {
   string $currentPanel = `getPanel -withFocus`;
   modelEditor -edit -da "wireframe" $currentPanel;
}