Go to: Return value. Flags. Examples.

Synopsis

circle [flags]

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

Return value

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

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 floatqueryedit
The start point of the circle if fixCenter is false. Determines the orientation of the circle if fixCenter is true.
-firstPointX (-fpx) linearqueryedit
X of the first point.
Default: 1
-firstPointY (-fpy) linearqueryedit
Y of the first point.
Default: 0
-firstPointZ (-fpz) linearqueryedit
Z of the first point.
Default: 0
-normal (-nr) float float floatqueryedit
The normal of the plane in which the circle will lie.
-normalX (-nrx) linearqueryedit
X of the normal direction.
Default: 0
-normalY (-nry) linearqueryedit
Y of the normal direction.
Default: 0
-normalZ (-nrz) linearqueryedit
Z of the normal direction.
Default: 1
-center (-c) float float floatqueryedit
The center point of the circle.
-centerX (-cx) linearqueryedit
X of the center point.
Default: 0
-centerY (-cy) linearqueryedit
Y of the center point.
Default: 0
-centerZ (-cz) linearqueryedit
Z of the center point.
Default: 0
-radius (-r) linearqueryedit
The radius of the circle.
Default: 1.0
-sweep (-sw) anglequeryedit
The sweep angle determines the completeness of the circle. A full circle is 2Pi radians, or 360 degrees.
Default: 6.2831853
-useTolerance (-ut) booleanqueryedit
Use the specified tolerance to determine resolution. Otherwise number of sections will be used.
Default: false
-degree (-d) integerqueryedit
The degree of the resulting circle: 1 - linear, 3 - cubic
Default: 3
-sections (-s) integerqueryedit
The number of sections determines the resolution of the circle. Used only if useTolerance is false.
Default: 8
-tolerance (-tol) linearqueryedit
The tolerance with which to build a circle. Used only if useTolerance is true
Default: 0.01
-fixCenter (-fc) booleanqueryedit
Fix the center of the circle to the specified center point. Otherwise the circle will start at the specified first point.
Default: true
-name (-n) stringcreate
Name the resulting object
-constructionHistory (-ch) booleancreate
Turn the construction history on or off (not available in all commands)
-object (-o) booleancreate
Create the result, or just the dependency node (not available in all commands)
-replaceOriginal (-rpo) booleancreate
Create "in place" (i.e., replace) (not available in all commands)
-curveOnSurface (-cos) booleancreate
If possible, create 2D curve as a result (not available in all commands)
-polygon (-po) integercreate
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) booleancreate
Force a curve range on complete input curve (not available in all commands)
-rebuild (-rb) booleancreate
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

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;