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

Synopsis

plane([length=linear], [name=string], [position=[linear, linear, linear]], [rotation=[angle, angle, angle]], [size=linear], [width=linear])

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

plane is undoable, NOT queryable, and NOT editable.

The command creates a sketch plane (also known as a "construction plane") in space. To create an object (such as a NURBS curve, joint chain or polygon) on a construction plane, you need to first make the plane live. See also the makeLive command.

Return value

string(name of the new plane)

Flags

length, name, position, rotation, size, width
Long name (short name) Argument types Properties
length(l) linear create
The length of plane. "linear" means that this flag can handle values with units.
name(n) string create
Name the resulting object.
position(p) [linear, linear, linear] create
3D position where the centre of the plane is positioned. "linear" means that this flag can handle values with units.
rotation(r) [angle, angle, angle] create
The rotation of plane. "angle" means that this flag can handle values with units.
size(s) linear create
The combined size (size x size) of plane. "linear" means that this flag can handle values with units.
width(w) linear create
The width of plane. "linear" means that this flag can handle values with units.

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

# Creates a plane of size (10x10) with center at (1,1,1)
cmds.plane( p=(1, 1, 1), s=10 )

# Creates a plane of size (10x10) with center at (1,1,1) using various units
cmds.plane( p=('1ft', '1ft', '1ft'), s='10in', r=('30deg', '30deg', '45deg') )