Go to: Synopsis. Flags. Return value. MEL examples.

Synopsis

circle [-center float float float] [-centerX linear] [-centerY linear] [-centerZ linear] [-constructionHistory boolean] [-curveOnSurface boolean] [-degree int] [-first float float float] [-firstPointX linear] [-firstPointY linear] [-firstPointZ linear] [-fixCenter boolean] [-name string] [-normal float float float] [-normalX linear] [-normalY linear] [-normalZ linear] [-object boolean] [-polygon int] [-radius linear] [-range boolean] [-rebuild boolean] [-replaceOriginal boolean] [-sections int] [-sweep angle] [-tolerance linear] [-useTolerance boolean]

circle is undoable, queryable, and editable.

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

Flags

center, centerX, centerY, centerZ, constructionHistory, curveOnSurface, degree, first, firstPointX, firstPointY, firstPointZ, fixCenter, name, normal, normalX, normalY, normalZ, object, polygon, radius, range, rebuild, replaceOriginal, sections, sweep, tolerance, useTolerance
Long name (short name) [argument types] Properties
-first(-fp) float float float queryedit
The start point of the circle if fixCenter is false. Determines the orientation of the circle if fixCenter is true.

In query mode, this flag needs a value.
-firstPointX(-fpx) linear queryedit
X of the first point.
Default: 1

In query mode, this flag needs a value.
-firstPointY(-fpy) linear queryedit
Y of the first point.
Default: 0

In query mode, this flag needs a value.
-firstPointZ(-fpz) linear queryedit
Z of the first point.
Default: 0

In query mode, this flag needs a value.
-normal(-nr) float float float queryedit
The normal of the plane in which the circle will lie.

In query mode, this flag needs a value.
-normalX(-nrx) linear queryedit
X of the normal direction.
Default: 0

In query mode, this flag needs a value.
-normalY(-nry) linear queryedit
Y of the normal direction.
Default: 0

In query mode, this flag needs a value.
-normalZ(-nrz) linear queryedit
Z of the normal direction.
Default: 1

In query mode, this flag needs a value.
-center(-c) float float float queryedit
The center point of the circle.

In query mode, this flag needs a value.
-centerX(-cx) linear queryedit
X of the center point.
Default: 0

In query mode, this flag needs a value.
-centerY(-cy) linear queryedit
Y of the center point.
Default: 0

In query mode, this flag needs a value.
-centerZ(-cz) linear queryedit
Z of the center point.
Default: 0

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

In query mode, this flag needs a value.
-sweep(-sw) angle queryedit
The sweep angle determines the completeness of the circle. A full circle 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 circle: 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 circle. Used only if useTolerance is false.
Default: 8

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

In query mode, this flag needs a value.
-fixCenter(-fc) boolean queryedit
Fix the center of the circle to the specified center point. Otherwise the circle will start at the specified first point.
Default: true

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 be used more than once in a command

Return value


[string[]] (object name and node name)

MEL examples

// create full circle at origin on the x-y plane
circle -nr 0 0 1 -c 0 0 0;

// create half circle at origin on the x-y plane with radius 2
circle -nr 0 0 1 -c 0 0 0 -sw 180 -r 2;