Your Ad Here

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

Synopsis

torus([absoluteSweepDifference=angle], [axis=[float, float, float]], [axisX=linear], [axisY=linear], [axisZ=linear], [constructionHistory=boolean], [curveOnSurface=boolean], [degree=int], [endSweep=angle], [heightRatio=float], [minorSweep=angle], [name=string], [object=boolean], [pivot=[float, float, float]], [pivotX=linear], [pivotY=linear], [pivotZ=linear], [polygon=int], [radius=linear], [range=boolean], [rebuild=boolean], [replaceOriginal=boolean], [sections=int], [spans=int], [startSweep=angle], [tolerance=linear], [useTolerance=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

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.

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, float] queryedit
The primitive's pivot point

In query mode, this flag needs a value.
pivotX(px) linear queryedit
X of the pivot
Default: 0

In query mode, this flag needs a value.
pivotY(py) linear queryedit
Y of the pivot
Default: 0

In query mode, this flag needs a value.
pivotZ(pz) linear queryedit
Z of the pivot
Default: 0

In query mode, this flag needs a value.
axis(ax) [float, float, float] queryedit
The primitive's axis

In query mode, this flag needs a value.
axisX(axx) linear queryedit
X of the axis
Default: 1

In query mode, this flag needs a value.
axisY(axy) linear queryedit
Y of the axis
Default: 0

In query mode, this flag needs a value.
axisZ(axz) linear queryedit
Z of the axis
Default: 0

In query mode, this flag needs a value.
radius(r) linear queryedit
The radius of the object
Default: 1.0

In query mode, this flag needs a value.
startSweep(ssw) angle queryedit
The angle at which to start the surface of revolution
Default: 0

In query mode, this flag needs a value.
endSweep(esw) angle queryedit
The angle at which to end the surface of revolution. Default is 2Pi radians, or 360 degrees.
Default: 6.2831853

In query mode, this flag needs a value.
useTolerance(ut) boolean queryedit
Use the specified tolerance to determine resolution. Otherwise number of sections will be used.
Default: false

In query mode, this flag needs a value.
degree(d) int queryedit
The degree of the resulting surface: 1 - linear, 3 - cubic
Default: 3

In query mode, this flag needs a value.
sections(s) int queryedit
The number of sections determines the resolution of the surface in the sweep direction. Used only if useTolerance is false.
Default: 8

In query mode, this flag needs a value.
spans(nsp) int queryedit
The number of spans determines the resolution of the surface in the opposite direction.
Default: 1

In query mode, this flag needs a value.
tolerance(tol) linear queryedit
The tolerance with which to build the surface. Used only if useTolerance is true
Default: 0.01

In query mode, this flag needs a value.
heightRatio(hr) float queryedit
Ratio of "height" to "width"
Default: 2.0

In query mode, this flag needs a value.
absoluteSweepDifference(asd) angle queryedit
The difference of endSweep - startSweep

In query mode, this flag needs a value.
minorSweep(msw) angle queryedit
The sweep angle for the minor circle in the torus
Default: 6.2831853

In query mode, this flag needs a value.
name(n) string create
Name the resulting object
constructionHistory(ch) boolean create
Turn the construction history on or off (not available in all commands)
object(o) boolean create
Create the result, or just the dependency node (not available in all commands)
replaceOriginal(rpo) boolean create
Create "in place" (i.e., replace) (not available in all commands)
curveOnSurface(cos) boolean create
If possible, create 2D curve as a result (not available in all commands)
polygon(po) int create
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) boolean create
Force a curve range on complete input curve (not available in all commands)
rebuild(rb) boolean create
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 have multiple arguments, passed either as a tuple or a list.

Return value


[string[]] (object name and node name) TdnPrimitive.incl TdnRevolvedPrimitive.incl TdnTorus.incl ModelSlice:TbaseModellingCmd.cpp

Related

cone, cylinder, nurbsCube, nurbsPlane, sphere

Python examples

import maya.cmds as cmds

cmds.torus()
cmds.torus( ch=True, radius=10, hr=3 )
cmds.torus( r=5, axis=(1, 1, 1), pivot=(0, 0, 1), ssw='0deg', esw='90deg', msw='45deg' )
cmds.torus( ut=True, tol=0.01 )

Return to Autodesk Index


Your Ad Here