pymel.core.modeling.polyPyramid

polyPyramid(*args, **kwargs)

The pyramid command creates a new polygonal pyramid.

Flags:

Long name (short name)		Argument Types	Properties
axis (ax)		float, float, float
	This flag specifies the primitive axis used to build the pyramid.Q: When queried, this flag returns a float[3].
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 primitive.The valid values are 0, 1, 2 or 3.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 primitive will be unwrapped and then the texture will be appliedwithout any distortion.In the unwrapped primitive, the shared edges will have shared UVs.2 implies the UVs should be normalized. This will normalize theU and V direction separately, thereby resulting in distortion of textures.4 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 3
name (n)		unicode
	Give a name to the resulting node.
nodeState (nds)		int
numberOfSides (ns)		int
	This specifies the number of sides for the pyramid base.C: Default is 3.Q: When queried, this flag returns an int.
numderOfSides (nsi)		int
object (o)		bool
	Create the result, or just the dependency node (where applicable).Common flags
sideLength (w)		float
	This flag specifies the edge length of the pyramid.C: Default is 2.0.Q: When queried, this flag returns a float.
subdivisionsCaps (sc)		int
	This flag specifies the number of subdivisions on bottom cap for the pyramid.C: Default is 0.Q: When queried, this flag returns an int.
subdivisionsHeight (sh)		int
	This flag specifies the number of subdivisions along height for the pyramid.C: Default is 1.Q: When queried, this flag returns an int.
texture (tx)		bool
	This flag is obsolete and will be removed in the next release. The -cuv/createUVs flag should be used instead.Common flags

Derived from mel command maya.cmds.polyPyramid

Example:

import pymel.core as pm

import maya.cmds as cmds

# Create a pyramid, with 10 subdivisions on the caps,
# 15 subdivisions along the height and num ber of sides 5,
# the side length of the pyramid is 20, the height of the pyramid is 10.
pm.polyPyramid( sc=10, sh=15, ns=5, w=20)

# Create a pyramid, called "mypyramid", olong height there are 5 subdivisions
# and with 5 sides.
pm.polyPyramid( n='mypyramid', sh=5, ns=5, sc=5)

# Query the side length of "mypyramid"
w = pm.polyPyramid( 'mypyramid', q=True, w=True )