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

Synopsis

polyCBoolOp( poly poly , [caching=boolean], [constructionHistory=boolean], [name=string], [nodeState=int], [object=boolean], [operation=int])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

polyCBoolOp is undoable, queryable, and editable.

This command creates a new poly as the result of a boolean operation on input polys : union, intersection, difference.
Only for difference, the order of the selected objects is important :
result = object1 - object2.
If no objects are specified in the command line, then the objects from the active list are used.

Return value

string[]Object name and node name.

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

Related

polyBoolOp, polySeparate, polyUnite

Flags

caching, constructionHistory, name, nodeState, object, operation
Long name (short name) Argument types Properties
operation(op) int create
1=union, 2=difference, 3=intersection
object(o) boolean create
Create the result, or just the dependency node (where applicable).
Common flags
name(n) string create
Give a name to the resulting node.
constructionHistory(ch) boolean createquery
Turn the construction history on or off (where applicable). If construction history is on then the corresponding node will be inserted into the history chain for the mesh. If construction history is off then the operation will be performed directly on the object.
Note: If the object already has construction history then this flag is ignored and the node will always be inserted into the history chain.
caching(cch) boolean createedit
Toggle caching for all attributes so that no recomputation is needed
nodeState(nds) int createqueryedit
Defines how to evaluate the node.
  • 0: Normal
  • 1: PassThrough
  • 2: Blocking
  • 3: Internally disabled. Will return to Normal state when enabled
  • 4: Internally disabled. Will return to PassThrough state when enabled
  • 5: Internally disabled. Will return to Blocking state when enabled
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

# Union
cmds.polyCube( n='Cube1', w=1, h=10, d=1 )
cmds.polyCube( n='cub1', w=3, h=3, d=3 )
cmds.polyCBoolOp( 'cub1', 'Cube1', op=1, n='result1' )

# Difference
cmds.polyCube( n='Cube2', w=1, h=10, d=1 )
cmds.polyCube( n='cub2', w=3, h=3, d=3 )
cmds.polyCBoolOp( 'cub2', 'Cube2', op=2, n='result2' )
cmds.move( 5, 0, 0, 'result2' )

# Intersection
cmds.polyCube( n='Cube3', w=1, h=10, d=1 )
cmds.polyCube( n='cub3', w=3, h=3, d=3 )
cmds.polyCBoolOp( 'cub3', 'Cube3', op=3, n='result3' )
cmds.move( 10, 0, 0, 'result3' )