pymel.core.modeling.torus

torus(*args, **kwargs)

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

Flags:

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

Derived from mel command maya.cmds.torus

Example:

import pymel.core as pm

pm.torus()
# Result: [nt.Transform(u'nurbsTorus1'), nt.MakeNurbTorus(u'makeNurbTorus1')] #
pm.torus( ch=True, radius=10, hr=3 )
# Result: [nt.Transform(u'nurbsTorus2'), nt.MakeNurbTorus(u'makeNurbTorus2')] #
pm.torus( r=5, axis=(1, 1, 1), pivot=(0, 0, 1), ssw='0deg', esw='90deg', msw='45deg' )
# Result: [nt.Transform(u'nurbsTorus3'), nt.MakeNurbTorus(u'makeNurbTorus3')] #
pm.torus( ut=True, tol=0.01 )
# Result: [nt.Transform(u'nurbsTorus4'), nt.MakeNurbTorus(u'makeNurbTorus4')] #
# query the torus radius
r = pm.torus( 'nurbsTorus1', r=True, q=True )