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

Synopsis

torus [-axis linear linear linear] [-caching boolean] [-constructionHistory boolean] [-degree int] [-endSweep angle] [-heightRatio float] [-minorSweep angle] [-name string] [-nodeState int] [-object boolean] [-pivot linear linear linear] [-polygon int] [-radius linear] [-sections int] [-spans int] [-startSweep angle] [-tolerance linear] [-useTolerance boolean]

torus is undoable, queryable, and editable.

The torus command creates a new torus and/or a dependency node that creates one, and returns their names.

Return value

string[] Object name and node name

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

Related

cone, cylinder, nurbsCube, nurbsPlane, sphere

Flags

axis, caching, constructionHistory, degree, endSweep, heightRatio, minorSweep, name, nodeState, object, pivot, polygon, radius, sections, spans, startSweep, tolerance, useTolerance
Long name (short name) Argument types Properties
-minorSweep(-msw) angle createqueryedit
The sweep angle for the minor circle in the torus
Default: 6.2831853
-radius(-r) linear createqueryedit
The radius of the object
Default: 1.0
-startSweep(-ssw) angle createqueryedit
The angle at which to start the surface of revolution
Default: 0
-endSweep(-esw) angle createqueryedit
The angle at which to end the surface of revolution. Default is 2Pi radians, or 360 degrees.
Default: 6.2831853
-useTolerance(-ut) boolean createqueryedit
Use the specified tolerance to determine resolution. Otherwise number of sections will be used.
Default: false
-degree(-d) int createqueryedit
The degree of the resulting surface: 1 - linear, 3 - cubic
Default: 3
-sections(-s) int createqueryedit
The number of sections determines the resolution of the surface in the sweep direction. Used only if useTolerance is false.
Default: 8
-spans(-nsp) int createqueryedit
The number of spans determines the resolution of the surface in the opposite direction.
Default: 1
-tolerance(-tol) linear createqueryedit
The tolerance with which to build the surface. Used only if useTolerance is true
Default: 0.01
-heightRatio(-hr) float createqueryedit
Ratio of "height" to "width"
Default: 2.0
-pivot(-p) linear linear linear createqueryedit
The primitive's pivot point
-axis(-ax) linear linear linear createqueryedit
The primitive's axis
Advanced flags
-caching(-cch) boolean createqueryedit
Modifies the node caching mode. See the node documentation for more information.
Note: For advanced users only.
-nodeState(-nds) int createqueryedit
Modifies the node state. See the node documentation for more information.
Note: For advanced users only.
Common flags
-name(-n) string create
Name the resulting object
-constructionHistory(-ch) boolean create
Turn the construction history on or off
-object(-o) boolean create
Create the result, or just the dependency node
-polygon(-po) int create
The value of this argument controls the type of the object created by this operation
  • 0: nurbs surface
  • 1: polygon (use nurbsToPolygonsPref to set the parameters for the conversion)
  • 2: subdivision surface (use nurbsToSubdivPref to set the parameters for the conversion)
  • 3: Bezier surface
  • 4: subdivision surface solid (use nurbsToSubdivPref to set the parameters for the conversion)
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

torus;
torus -ch true -radius 10 -hr 3;
torus -r 5 -axis 1 1 1 -pivot 0 0 1 -ssw 0deg -esw 90deg -msw 45deg;
torus -ut true -tol 0.01;
// query the torus radius
float $r = `torus -q -radius nurbsTorus1`;