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

Synopsis

polyPyramid [-axis linear linear linear] [-constructionHistory boolean] [-createUVs int] [-name string] [-numberOfSides int] [-object boolean] [-sideLength linear] [-subdivisionsCaps int] [-subdivisionsHeight int] [-texture boolean]

polyPyramid is undoable, queryable, and editable.

The pyramid command creates a new polygonal pyramid.

Return value

string[]Object name and node name.

In query mode, return type is based on queried flag.

Related

polyCube, polyCylinder, polyPlane, polyPrism, polySphere, polyTorus

Flags

axis, constructionHistory, createUVs, name, numberOfSides, object, sideLength, subdivisionsCaps, subdivisionsHeight, texture
Long name (short name) Argument types Properties
-axis(-ax) linear linear linear createqueryedit
This flag specifies the primitive axis used to build the pyramid.
Q: When queried, this flag returns a float[3].
-sideLength(-w) linear createqueryedit
This flag specifies the edge length of the pyramid.
C: Default is 2.0.
Q: When queried, this flag returns a float.
-numberOfSides(-ns) int createqueryedit
This specifies the number of sides for the pyramid base.
C: Default is 3.
Q: When queried, this flag returns an int.
-subdivisionsHeight(-sh) int createqueryedit
This flag specifies the number of subdivisions along height for the pyramid.
C: Default is 1.
Q: When queried, this flag returns an int.
-subdivisionsCaps(-sc) int createqueryedit
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.
-createUVs(-cuv) int create
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 applied
without any distortion.
In the unwrapped primitive, the shared edges will have shared UVs.

2 implies the UVs should be normalized. This will normalize the
U 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 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 3
-texture(-tx) boolean create
This flag is obsolete and will be removed in the next release. The -cuv/createUVs flag should be used instead.
Common flags
-object(-o) boolean create
Create the result, or just the dependency node (where applicable).
Common flags
-name(-n) string create
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.
-constructionHistory(-ch) boolean createquery
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 command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// 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.
polyPyramid -sc 10 -sh 15 -ns 5 -w 20;

// Create a pyramid, called "mypyramid", olong height there are 5 subdivisions
// and with 5 sides.
polyPyramid -n mypyramid -sh 5 -ns 5 -sc 5;

// Query the side length of "mypyramid"
float $w = `polyPyramid -q -w mypyramid`;