polyCube

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

Synopsis

polyCube [-axis linear linear linear] [-constructionHistory boolean] [-createUVs int] [-depth linear] [-height linear] [-name string] [-object boolean] [-subdivisionsX int] [-subdivisionsY int] [-subdivisionsZ int] [-texture int] [-width linear]

polyCube is undoable, queryable, and editable.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
-axis(-ax)	linear linear linear
This flag specifies the primitive axis used to build the cube. Q: When queried, this flag returns a float[3].
-width(-w)	linear
This flag specifies the width of the cube. C: Default is 1.0. Q: When queried, this flag returns a float.
-height(-h)	linear
This flag specifies the height of the cube. C: Default is 1.0. Q: When queried, this flag returns a float.
-depth(-d)	linear
This flag specifies the depth of the cube. C: Default is 1.0. Q: When queried, this flag returns a float.
-subdivisionsX(-sx)	int
This specifies the number of subdivisions in the X direction for the cube. C: Default is 1. Q: When queried, this flag returns an int.
-subdivisionsY(-sy)	int
This flag specifies the number of subdivisions in the Y direction for the cube. C: Default is 1. Q: When queried, this flag returns an int.
-subdivisionsZ(-sz)	int
This flag specifies the number of subdivisions in the Z direction for the cube. C: Default is 1. Q: When queried, this flag returns an int.
-createUVs(-cuv)	int
This flag alows a specific UV mechanism to be selected, while creating the cube. The valid values are 0, 1, 2 ,3 or 4. 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 cube will be unwrapped and then the texture will be applied without any distortion. In the unwrapped cube, the shared edges will have shared UVs. 2 implies UVs are created separately for each of the faces of the cube. 3 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 4
-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
-object(-o)	boolean
Create the result, or just the dependency node (where applicable).
Common flags
-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.
-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.

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

polyCube -sx 10 -sy 15 -sz 5 -h 20;
//result is a 20 units height rectangular box
//with 10 subdivisions along X, 15 along Y and 20 along Z.

polyCube -sx 5 -sy 5 -sz 5;
//result has 5 subdivisions along all directions, default size

// Query the width of a cube
float $w = `polyCube -q -w polyCube1`;