Go to: Synopsis. Return value. Flags. Python examples.
circle([caching=boolean], [center=[linear, linear, linear]], [centerX=linear], [centerY=linear], [centerZ=linear], [constructionHistory=boolean], [degree=int], [first=[linear, linear, linear]], [firstPointX=linear], [firstPointY=linear], [firstPointZ=linear], [fixCenter=boolean], [name=string], [nodeState=int], [normal=[linear, linear, linear]], [normalX=linear], [normalY=linear], [normalZ=linear], [object=boolean], [radius=linear], [sections=int], [sweep=angle], [tolerance=linear], [useTolerance=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
circle is undoable, queryable, and editable.
The circle command creates a circle or partial circle (arc)
string[] | Object name and node name |
In query mode, return type is based on queried flag.
caching, center, centerX, centerY, centerZ, constructionHistory, degree, first, firstPointX, firstPointY, firstPointZ, fixCenter, name, nodeState, normal, normalX, normalY, normalZ, object, radius, sections, sweep, tolerance, useTolerance
Long name (short name) |
Argument types |
Properties |
|
center(c)
|
[linear, linear, linear]
|
|
|
The center point of the circle.
|
|
centerX(cx)
|
linear
|
|
|
X of the center point.
Default: 0
|
|
centerY(cy)
|
linear
|
|
|
Y of the center point.
Default: 0
|
|
centerZ(cz)
|
linear
|
|
|
Z of the center point.
Default: 0
|
|
degree(d)
|
int
|
|
|
The degree of the resulting circle:
1 - linear,
3 - cubic
Default: 3
|
|
first(fp)
|
[linear, linear, linear]
|
|
|
The start point of the circle if fixCenter is false.
Determines the orientation of the circle if fixCenter is true.
|
|
firstPointX(fpx)
|
linear
|
|
|
X of the first point.
Default: 1
|
|
firstPointY(fpy)
|
linear
|
|
|
Y of the first point.
Default: 0
|
|
firstPointZ(fpz)
|
linear
|
|
|
Z of the first point.
Default: 0
|
|
fixCenter(fc)
|
boolean
|
|
|
Fix the center of the circle to the specified center point.
Otherwise the circle will start at the specified first point.
Default: true
|
|
normal(nr)
|
[linear, linear, linear]
|
|
|
The normal of the plane in which the circle will lie.
|
|
normalX(nrx)
|
linear
|
|
|
X of the normal direction.
Default: 0
|
|
normalY(nry)
|
linear
|
|
|
Y of the normal direction.
Default: 0
|
|
normalZ(nrz)
|
linear
|
|
|
Z of the normal direction.
Default: 1
|
|
radius(r)
|
linear
|
|
|
The radius of the circle.
Default: 1.0
|
|
sections(s)
|
int
|
|
|
The number of sections determines the resolution of the circle.
Used only if useTolerance is false.
Default: 8
|
|
sweep(sw)
|
angle
|
|
|
The sweep angle determines the completeness of the circle.
A full circle is 2Pi radians, or 360 degrees.
Default: 6.2831853
|
|
tolerance(tol)
|
linear
|
|
|
The tolerance with which to build a circle.
Used only if useTolerance is true
Default: 0.01
|
|
useTolerance(ut)
|
boolean
|
|
|
Use the specified tolerance to determine resolution.
Otherwise number of sections will be used.
Default: false
|
|
Common flags |
constructionHistory(ch)
|
boolean
|
|
|
Turn the construction history on or off.
|
|
name(n)
|
string
|
|
|
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.
|
|
object(o)
|
boolean
|
|
|
Create the result, or just the dependency node.
|
|
Advanced flags |
caching(cch)
|
boolean
|
|
|
Modifies the node caching mode. See the node documentation for more information.
Note: For advanced users only.
|
|
nodeState(nds)
|
int
|
|
|
Modifies the node state. See the node documentation for more information.
Note: For advanced users only.
|
|
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.
|
import maya.cmds as cmds
# create full circle at origin on the x-y plane
cmds.circle( nr=(0, 0, 1), c=(0, 0, 0) )
# create half circle at origin on the x-y plane with radius 2
cmds.circle( nr=(0, 0, 1), c=(0, 0, 0), sw=180, r=2 )