pymel.core.modeling.circle

circle(*args, **kwargs)

The circle command creates a circle or partial circle (arc)

Flags:
Long name (short name) Argument Types Properties
caching (cch) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Modifies the node caching mode. See the node documentation for more information. Note:For advanced users only.
center (c) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The center point of the circle.
centerX (cx) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
X of the center point. Default:0
centerY (cy) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Y of the center point. Default:0
centerZ (cz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Z of the center point. Default:0
constructionHistory (ch) bool ../../../_images/create.gif
 
Turn the construction history on or off
degree (d) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The degree of the resulting circle: 1 - linear, 3 - cubic Default:3
first (fp) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The start point of the circle if fixCenter is false. Determines the orientation of the circle if fixCenter is true.
firstPointX (fpx) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
X of the first point. Default:1
firstPointY (fpy) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Y of the first point. Default:0
firstPointZ (fpz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Z of the first point. Default:0
fixCenter (fc) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Fix the center of the circle to the specified center point. Otherwise the circle will start at the specified first point. Default:true Advanced flags

name (n) unicode ../../../_images/create.gif
 
Name the resulting object
nodeState (nds) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Modifies the node state. See the node documentation for more information. Note:For advanced users only. Common flags
normal (nr) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The normal of the plane in which the circle will lie.
normalX (nrx) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
X of the normal direction. Default:0
normalY (nry) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Y of the normal direction. Default:0
normalZ (nrz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Z of the normal direction. Default:1
object (o) bool ../../../_images/create.gif
 
Create the result, or just the dependency node Flag can have multiple arguments, passed either as a tuple or a list.
radius (r) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The radius of the circle. Default:1.0
sections (s) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The number of sections determines the resolution of the circle. Used only if useTolerance is false. Default:8
sweep (sw) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The sweep angle determines the completeness of the circle. A full circle is 2Pi radians, or 360 degrees. Default:6.2831853
tolerance (tol) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The tolerance with which to build a circle. Used only if useTolerance is true Default:0.01
useTolerance (ut) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Use the specified tolerance to determine resolution. Otherwise number of sections will be used. Default:false

Derived from mel command maya.cmds.circle

Example:

import pymel.core as pm

# create full circle at origin on the x-y plane
pm.circle( nr=(0, 0, 1), c=(0, 0, 0) )
# Result: [nt.Transform(u'nurbsCircle1'), nt.MakeNurbCircle(u'makeNurbCircle1')] #

# create half circle at origin on the x-y plane with radius 2
pm.circle( nr=(0, 0, 1), c=(0, 0, 0), sw=180, r=2 )
# Result: [nt.Transform(u'nurbsCircle2'), nt.MakeNurbCircle(u'makeNurbCircle2')] #

Previous topic

pymel.core.modeling.changeSubdivRegion

Next topic

pymel.core.modeling.circularFillet

Core

Core Modules

Other Modules

This Page