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

Synopsis

polyTorus [-axis linear linear linear] [-caching boolean] [-constructionHistory boolean] [-createUVs boolean] [-name string] [-nodeState int] [-object boolean] [-radius linear] [-sectionRadius linear] [-subdivisionsAxis int] [-subdivisionsHeight int] [-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, caching, constructionHistory, createUVs, name, nodeState, object, radius, sectionRadius, subdivisionsAxis, subdivisionsHeight, subdivisionsX, subdivisionsY, texture, twist
Long name (short name) Argument types Properties
Common poly creation operation flags
-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.
-caching(-cch) boolean createqueryedit
Toggle caching for all attributes so that no recomputation is needed
-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.
-createUVs(-cuv) boolean createqueryedit
Create UVs or not.
Default: true
-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.
-nodeState(-nds) int createqueryedit

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
Create the result, or just the dependency node (where applicable).
-radius(-r) linear createqueryedit
Radius of the torus.
Default: 1.0
-sectionRadius(-sr) linear createqueryedit
Section of the torus.
Default: 0.50
-subdivisionsAxis(-sa) int createqueryedit
Subdivisions about the vertical axis.
Default: 20
-subdivisionsHeight(-sh) int createqueryedit
Subdivisions along the height.
Default: 20
-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.
-texture(-tx) boolean createqueryedit
Apply texture or not. this is an old attribute. This is unsupported and would be removed in a future release.
Default: true
-twist(-tw) angle createqueryedit
Twist angle of the torus.
Default: 0.0
Common flags

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`;