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

Synopsis

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

circle is undoable, queryable, and editable.

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

Return value

string[]Object name and node name

In query mode, return type is based on queried flag.

Flags

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
-first(-fp) float float float createqueryedit
The start point of the circle if fixCenter is false. Determines the orientation of the circle if fixCenter is true.
-firstPointX(-fpx) linear createqueryedit
X of the first point.
Default: 1
-firstPointY(-fpy) linear createqueryedit
Y of the first point.
Default: 0
-firstPointZ(-fpz) linear createqueryedit
Z of the first point.
Default: 0
-normal(-nr) float float float createqueryedit
The normal of the plane in which the circle will lie.
-normalX(-nrx) linear createqueryedit
X of the normal direction.
Default: 0
-normalY(-nry) linear createqueryedit
Y of the normal direction.
Default: 0
-normalZ(-nrz) linear createqueryedit
Z of the normal direction.
Default: 1
-center(-c) float float float createqueryedit
The center point of the circle.
-centerX(-cx) linear createqueryedit
X of the center point.
Default: 0
-centerY(-cy) linear createqueryedit
Y of the center point.
Default: 0
-centerZ(-cz) linear createqueryedit
Z of the center point.
Default: 0
-radius(-r) linear createqueryedit
The radius of the circle.
Default: 1.0
-sweep(-sw) angle createqueryedit
The sweep angle determines the completeness of the circle. A full circle is 2Pi radians, or 360 degrees.
Default: 6.2831853
-useTolerance(-ut) boolean createqueryedit
Use the specified tolerance to determine resolution. Otherwise number of sections will be used.
Default: false
-degree(-d) int createqueryedit
The degree of the resulting circle: 1 - linear, 3 - cubic
Default: 3
-sections(-s) int createqueryedit
The number of sections determines the resolution of the circle. Used only if useTolerance is false.
Default: 8
-tolerance(-tol) linear createqueryedit
The tolerance with which to build a circle. Used only if useTolerance is true
Default: 0.01
-fixCenter(-fc) boolean createqueryedit
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
-caching(-cch) boolean createqueryedit
Modifies the node caching mode. See the node documentation for more information.
Note: For advanced users only.
-nodeState(-nds) int createqueryedit
Modifies the node state. See the node documentation for more information.
Note: For advanced users only.
Common flags
-name(-n) string create
Name the resulting object
-constructionHistory(-ch) boolean create
Turn the construction history on or off
-object(-o) boolean create
Create the result, or just the dependency node
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.

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;