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

Synopsis

polyPlane([axis=[float, float, float]], [constructionHistory=boolean], [createUVs=int], [height=linear], [name=string], [object=boolean], [subdivisionsX=int], [subdivisionsY=int], [texture=boolean], [width=linear])

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

polyPlane is undoable, queryable, and editable.

The mesh command creates a new polygonal plane.

Flags

axis, constructionHistory, createUVs, height, name, object, subdivisionsX, subdivisionsY, texture, width
Long name (short name) [argument types] Properties
axis(ax) [float, float, float] createqueryedit
This flag specifies the primitive axis used to build the plane.

In query mode, this flag needs a value.
width(w) linear createqueryedit
This flag specifies the width of the plane.
Default is 1.0.

In query mode, this flag needs a value.
height(h) linear createqueryedit
This flag specifies the height of the plane.
Default is 1.0.

In query mode, this flag needs a value.
subdivisionsX(sx) int createqueryedit
This specifies the number of subdivisions in the X direction for the plane.
Default is 5.

In query mode, this flag needs a value.
subdivisionsY(sy) int createqueryedit
This flag specifies the number of subdivisions in the Y direction for the plane.
Default is 5.

In query mode, this flag needs a value.
createUVs(cuv) int create
This flag alows a specific UV mechanism to be selected, while creating the plane. The valid values are 0, 1 or 2.
0 implies that no UVs will be generated (No texture to be applied).

1 implies UVs should be created for the object as a whole without any normalization.
The helix will be unwrapped and then the texture will be applied without any distortion.
In the unwrapped helix, the shared edges will have shared UVs.

2 implies UVs are created so that the texture will not be distorted when applied.
The texture lying outside the UV range will be truncated (since that cannot be
squeezed in, without distorting the texture.

For better understanding of these options, you may have to open the
texture view window

C: Default is 2
texture(tx) boolean create
This flag is obsolete and will be removed in the next release. The cuv/createUVs flag should be used instead.
name(n) string create
Gives a name to the created plane.
constructionHistory(ch) boolean createquery
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.
object(o) boolean create
Create the result, or just the dependency node (where applicable).
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.

Return value


string string Object name and node name.

Related

polyCone, polyCube, polyCube, polyCylinder, polySphere, polyTorus

Python examples

import maya.cmds as cmds

# Create a mesh (plane), with 10 subdivisions in the X direction,
# 15 subdivisions in the Y direction,
# the width of the mesh is 15, the height of the mesh is 20.
cmds.polyPlane( sx=10, sy=15, w=15, h=20)

# Create a mesh, called "myPlane", on each direction there are 5 subdivisions.
cmds.polyPlane(n='myPlane', sx=5, sy=5)