pymel.core.modeling.polyPlane

polyPlane(*args, **kwargs)

The mesh command creates a new polygonal plane.

Flags:

Long name (short name)		Argument Types	Properties
axis (ax)		float, float, float
	This flag specifies the primitive axis used to build the plane.
caching (cch)		bool
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.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
createUVs (cuv)		int
	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 besqueezed in, without distorting the texture.For better understanding of these options, you may have to open thetexture view windowC: Default is 2
height (h)		float
	This flag specifies the height of the plane.Default is 1.0.
name (n)		unicode
	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.
nodeState (nds)		int
object (o)		bool
	Create the result, or just the dependency node (where applicable).Common flags
subdivisionsHeight (sh)		int
subdivisionsWidth (sw)		int
subdivisionsX (sx)		int
	This specifies the number of subdivisions in the X direction for the plane.Default is 5.
subdivisionsY (sy)		int
	This flag specifies the number of subdivisions in the Y direction for the plane.Default is 5.
texture (tx)		int
	This flag is obsolete and will be removed in the next release. The cuv/createUVs flag should be used instead.Common flags
width (w)		float
	This flag specifies the width of the plane.Default is 1.0.

Derived from mel command maya.cmds.polyPlane

Example:

import pymel.core as pm

# 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.
pm.polyPlane( sx=10, sy=15, w=15, h=20)

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