Go to: Synopsis. Return value. Related. Flags. Python examples.
polyPlane([axis=[linear, linear, linear]], [caching=boolean], [constructionHistory=boolean], [createUVs=int], [height=linear], [name=string], [nodeState=int], [object=boolean], [subdivisionsHeight=int], [subdivisionsWidth=int], [subdivisionsX=int], [subdivisionsY=int], [texture=int], [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.
Create a new polygonal plane.
string[] | Object name and node name. |
In query mode, return type is based on queried flag.
polyCone, polyCube, polyCube, polyCylinder, polySphere, polyTorus
axis, caching, constructionHistory, createUVs, height, name, nodeState, object, subdivisionsHeight, subdivisionsWidth, subdivisionsX, subdivisionsY, texture, width
Long name (short name) |
Argument types |
Properties |
|
Flags from nodes |
axis(ax)
|
[linear, linear, linear]
|
|
|
This flag specifies the primitive axis used to build the plane.
|
|
createUVs(cuv)
|
int
|
|
|
Create UVs or not.
- 0: No UVs
- 1: No Normalization
- 2: Normalize and Preserve Aspect Ratio
Default: 1
|
|
height(h)
|
linear
|
|
|
Height of the plane.
Default: 1.0
|
|
subdivisionsHeight(sh)
|
int
|
|
|
Subdivisions along the height of the sphere.
|
|
subdivisionsWidth(sw)
|
int
|
|
|
Subdivisions along the width of the plane.
Default: 10
|
|
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
|
|
|
What texture mechanism to be applied.
0=No textures; 1=stretch to fit;
2=preserve aspect ratio
Default: 1
|
|
width(w)
|
linear
|
|
|
Width of the plane.
Default: 1.0
|
|
Common poly creation operation flags |
caching(cch)
|
boolean
|
|
|
Toggle caching for all attributes so that no recomputation is needed
|
|
constructionHistory(ch)
|
boolean
|
|
|
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.
|
|
name(n)
|
string
|
|
|
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
|
|
|
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-Blocking will reset
back to Blocking.
The Normal and Blocking cases apply to all nodes, while
HasNoEffect is node specific; many nodes do not support this option.
Plug-ins store state in the MPxNode::state attribute. Anyone can set
it or check this attribute. Additional details about each of these 3 states follow.
State |
Description |
Normal |
The normal node state. This is the default. |
HasNoEffect |
The HasNoEffect option (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.
It’s typical to implement support for the HasNoEffect state in
the node’s 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.
|
Blocking |
This is implemented in the depend node base class and applies to all nodes.
Blocking is 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 Blocking the 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 won’t evaluate after that. Note that a blocked
node will still respond to getAttr requests but a getAttr on a
downstream node will not reevaluate the blocked node.
Setting the root transform of a hierarchy to Blocking won’t automatically
influence child transforms in the hierarchy. To do this, you’d need to
explicitly set all child nodes to the Blocking state.
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
|
|
object(o)
|
boolean
|
|
|
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.
|
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)