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

Synopsis

polyTorus [-axis linear linear linear] [-constructionHistory boolean] [-createUVs boolean] [-name string] [-object boolean] [-radius linear] [-sectionRadius linear] [-subdivisionsX int] [-subdivisionsY int] [-texture boolean] [-twist angle]

polyTorus is undoable, queryable, and editable.

The torus command creates a new polygonal torus.

Return value

string[]Object name and node name.

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

Related

polyCone, polyCube, polyCube, polyCylinder, polyPlane, polySphere

Flags

axis, constructionHistory, createUVs, name, object, radius, sectionRadius, subdivisionsX, subdivisionsY, texture, twist
Long name (short name) Argument types Properties
-axis(-ax) linear linear linear createqueryedit
This flag specifies the primitive axis used to build the torus.
Q: When queried, this flag returns a vector.
-radius(-r) linear createqueryedit
This flag specifies the radius of the torus.
C: Default is 0.5.
Q: When queried, this flag returns a float.
-sectionRadius(-sr) linear createqueryedit
This flag specifies the section radius of the torus.
C: Default is 0.25.
Q: When queried, this flag returns a float.
-twist(-tw) angle createqueryedit
This flag specifies the section twist of the torus.
C: Default is 0.0.
Q: When queried, this flag returns a float.
-subdivisionsX(-sx) int createqueryedit
This specifies the number of subdivisions in the X direction for the torus (number of sections).
C: Default is 20.
Q: When queried, this flag returns an int.
-subdivisionsY(-sy) int createqueryedit
This flag specifies the number of subdivisions in the Y direction for the torus (number of segments per section).
C: Default is 20.
Q: When queried, this flag returns an int.
-createUVs(-cuv) boolean createqueryedit
This flag alows a texture to be applied.
C: Default is "on" (uv's are computed).
Q: When queried, this flag returns an int.
-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

polyTorus -sx 8 -sy 16 -r 10 -sr 1;
//result has 8 sections of 16 segments,
//the main radius is 10, the section radius is 1.

polyTorus -sx 5 -sy 4 -tx off; move -3 0 0;
//result has 5 sections of 4 segments, default sizes.
//no texture offsets are generated.

polyTorus -sx 5 -sy 4 -tw 45; move 3 0 0;
//result has 5 sections of 4 segments, default sizes.
//The sections are rotated.

// Query the radius of the torus
float $r = `polyTorus -q -r polyTorus1`;