Go to: Return value. Related commands. Flags. Examples.

Synopsis

torus [flags]

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)

Related commands

cone, cylinder, sphere, nurbsPlane, nurbsCube

Flags

absoluteSweepDifference, axis, axisX, axisY, axisZ, constructionHistory, curveOnSurface, degree, endSweep, heightRatio, minorSweep, name, object, pivot, pivotX, pivotY, pivotZ, polygon, radius, range, rebuild, replaceOriginal, sections, spans, startSweep, tolerance, useTolerance

Long name (short name)[argument types]Properties
-pivot (-p) float float floatqueryedit
The primitive's pivot point
-pivotX (-px) linearqueryedit
X of the pivot
Default: 0
-pivotY (-py) linearqueryedit
Y of the pivot
Default: 0
-pivotZ (-pz) linearqueryedit
Z of the pivot
Default: 0
-axis (-ax) float float floatqueryedit
The primitive's axis
-axisX (-axx) linearqueryedit
X of the axis
Default: 1
-axisY (-axy) linearqueryedit
Y of the axis
Default: 0
-axisZ (-axz) linearqueryedit
Z of the axis
Default: 0
-radius (-r) linearqueryedit
The radius of the object
Default: 1.0
-startSweep (-ssw) anglequeryedit
The angle at which to start the surface of revolution
Default: 0
-endSweep (-esw) anglequeryedit
The angle at which to end the surface of revolution. Default is 2Pi radians, or 360 degrees.
Default: 6.2831853
-useTolerance (-ut) booleanqueryedit
Use the specified tolerance to determine resolution. Otherwise number of sections will be used.
Default: false
-degree (-d) integerqueryedit
The degree of the resulting surface: 1 - linear, 3 - cubic
Default: 3
-sections (-s) integerqueryedit
The number of sections determines the resolution of the surface in the sweep direction. Used only if useTolerance is false.
Default: 8
-spans (-nsp) integerqueryedit
The number of spans determines the resolution of the surface in the opposite direction.
Default: 1
-tolerance (-tol) linearqueryedit
The tolerance with which to build the surface. Used only if useTolerance is true
Default: 0.01
-heightRatio (-hr) floatqueryedit
Ratio of "height" to "width"
Default: 2.0
-absoluteSweepDifference (-asd) anglequeryedit
The difference of endSweep - startSweep
-minorSweep (-msw) anglequeryedit
The sweep angle for the minor circle in the torus
Default: 6.2831853
-name (-n) stringcreate
Name the resulting object
-constructionHistory (-ch) booleancreate
Turn the construction history on or off (not available in all commands)
-object (-o) booleancreate
Create the result, or just the dependency node (not available in all commands)
-replaceOriginal (-rpo) booleancreate
Create "in place" (i.e., replace) (not available in all commands)
-curveOnSurface (-cos) booleancreate
If possible, create 2D curve as a result (not available in all commands)
-polygon (-po) integercreate
The value of this argument controls the type of the object created by this operation (not available in all commands) - 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)
-range (-rn) booleancreate
Force a curve range on complete input curve (not available in all commands)
-rebuild (-rb) booleancreate
Rebuild the input curve(s) before using them in the operation. Use nurbsCurveRebuildPref to set the parameters for the conversion. (not available in all commands)
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

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 -utl true -tol 0.01;