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

Synopsis

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)

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
caching(cch) boolean createqueryedit
Toggle caching for all attributes so that no recomputation is needed
center(c) [linear, linear, linear] 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
degree(d) int createqueryedit
The degree of the resulting circle: 1 - linear, 3 - cubic
Default: 3
first(fp) [linear, linear, linear] 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
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
nodeState(nds) int createqueryedit

Maya dependency nodes have 6 possible states. The Normal (0), HasNoEffect (1), and Blocking (2) states can be used to alter how the graph is evaluated.

The Waiting-Normal (3), Waiting-HasNoEffect (4), Waiting-Blocking (5) are for internal use only. They temporarily shut off parts of the graph during interaction (e.g., manipulation). The understanding is that once the operation is done, the state will be reset appropriately, e.g. Waiting-Blocking will reset back to Blocking.

The Normal and Blocking cases apply to all nodes, while HasNoEffect is node specific; many nodes do not support this option. Plug-ins store state in the MPxNode::state attribute. Anyone can set it or check this attribute. Additional details about each of these 3 states follow.

State Description
Normal The normal node state. This is the default.
HasNoEffect

The HasNoEffect option (a.k.a. pass-through), is used in cases where there is an operation on an input producing an output of the same data type. Nearly all deformers support this state, as do a few other nodes. As stated earlier, it is not supported by all nodes.

It’s typical to implement support for the HasNoEffect state in the node’s compute method and to perform appropriate operations. Plug-ins can also support HasNoEffect.

The usual implementation of this state is to copy the input directly to the matching output without applying the algorithm in the node. For deformers, applying this state leaves the input geometry undeformed on the output.

Blocking

This is implemented in the depend node base class and applies to all nodes. Blocking is applied during the evaluation phase to connections. An evaluation request to a blocked connection will return as failures, causing the destination plug to retain its current value. Dirty propagation is indirectly affected by this state since blocked connections are never cleaned.

When a node is set to Blocking the behavior is supposed to be the same as if all outgoing connections were broken. As long as nobody requests evaluation of the blocked node directly it won’t evaluate after that. Note that a blocked node will still respond to getAttr requests but a getAttr on a downstream node will not reevaluate the blocked node.

Setting the root transform of a hierarchy to Blocking won’t automatically influence child transforms in the hierarchy. To do this, you’d need to explicitly set all child nodes to the Blocking state.

For example, to set all child transforms to Blocking, you could use the following script.


import maya.cmds as cmds
def blockTree(root):
nodesToBlock = []
for node in {child:1 for child in cmds.listRelatives( root, path=True, allDescendents=True )}.keys():
nodesToBlock += cmds.listConnections(node, source=True, destination=True )
for node in {source:1 for source in nodesToBlock}.keys():
cmds.setAttr( '%s.nodeState' % node, 2 )

Applying this script would continue to draw objects but things would not be animated.


Default: kdnNormal
normal(nr) [linear, linear, linear] 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
radius(r) linear createqueryedit
The radius of the circle.
Default: 1.0
sections(s) int createqueryedit
The number of sections determines the resolution of the circle. Used only if useTolerance is false.
Default: 8
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
tolerance(tol) linear createqueryedit
The tolerance with which to build a circle. Used only if useTolerance is true
Default: 0.01
useTolerance(ut) boolean createqueryedit
Use the specified tolerance to determine resolution. Otherwise number of sections will be used.
Default: false
Common flags
constructionHistory(ch) boolean create
Turn the construction history on or off.
name(n) string create
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
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 have multiple arguments, passed either as a tuple or a list.

Python examples

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 )