polyCut

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

Synopsis

polyCut([caching=boolean], [constructionHistory=boolean], [cutPlaneCenter=[linear, linear, linear]], [cutPlaneCenterX=linear], [cutPlaneCenterY=linear], [cutPlaneCenterZ=linear], [cutPlaneHeight=linear], [cutPlaneRotate=[angle, angle, angle]], [cutPlaneRotateX=angle], [cutPlaneRotateY=angle], [cutPlaneRotateZ=angle], [cutPlaneSize=[linear, linear]], [cutPlaneWidth=linear], [cuttingDirection=string], [deleteFaces=boolean], [extractFaces=boolean], [extractOffset=[linear, linear, linear]], [extractOffsetX=linear], [extractOffsetY=linear], [extractOffsetZ=linear], [name=string], [nodeState=int], [worldSpace=boolean])

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

polyCut is undoable, queryable, and editable.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
cutPlaneCenter(pc)	[linear, linear, linear]
This flag specifies the position of the cutting plane.
cutPlaneCenterX(pcx)	linear
This flag specifies the X position of the cutting plane.
cutPlaneCenterY(pcy)	linear
This flag specifies the Y position of the cutting plane.
cutPlaneCenterZ(pcz)	linear
This flag specifies the Z position of the cutting plane.
cutPlaneHeight(ph)	linear
This flag specifies the height of the cutting plane. This is used only for displaying the manipulator, and has no effect on the cut operation.
cutPlaneRotate(ro)	[angle, angle, angle]
This flag specifies the orientation of the cutting plane.
cutPlaneRotateX(rx)	angle
This flag specifies the X rotation of the cutting plane.
cutPlaneRotateY(ry)	angle
This flag specifies the Y rotation of the cutting plane.
cutPlaneRotateZ(rz)	angle
This flag specifies the Z rotation of the cutting plane.
cutPlaneSize(ps)	[linear, linear]
This flag specifies the size of the cutting plane. This is used only for displaying the manipulator, and has no effect on the cut operation.
cutPlaneWidth(pw)	linear
This flag specifies the width of the cutting plane. This is used only for displaying the manipulator, and has no effect on the cut operation.
cuttingDirection(cd)	string
This flag specifies the direction of the cutting plane. Valid values are "x", "y", "z" A value of "x" will cut the object along the YZ plane cutting through the center of the bounding box. A value of "y" will cut the object along the ZX plane cutting through the center of the bounding box. A value of "z" will cut the object along the XY plane cutting through the center of the bounding box.
deleteFaces(df)	boolean
This flag specifies if the cut faces should be deleted or not.
extractFaces(ef)	boolean
This flag specifies if the cut faces should be extracted or not.
extractOffset(eo)	[linear, linear, linear]
This flag specifies the offset by which the cut faces will be extracted. This flag has no effect when the "extractFaces" is turned off.
extractOffsetX(eox)	linear
This flag specifies the offset in X by which the cut faces will be extracted. This flag has no effect when the "extractFaces" is turned off.
extractOffsetY(eoy)	linear
This flag specifies the offset in Y by which the cut faces will be extracted. This flag has no effect when the "extractFaces" is turned off.
extractOffsetZ(eoz)	linear
This flag specifies the offset in Z by which the cut faces will be extracted. This flag has no effect when the "extractFaces" is turned off.
worldSpace(ws)	boolean
This flag is ignored. polyCut command always works on worldSpace.
Common flags
caching(cch)	boolean
Toggle caching for all attributes so that no recomputation is needed.
constructionHistory(ch)	boolean
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.
name(n)	string
Give a name to the resulting node.
nodeState(nds)	int
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

# Introduce new edges at the middle of a cylinder
#
cmds.polyCylinder( r=1, h=2, sx=20, sy=1, sz=1, ax=(0, 1, 0), cuv=1, ch=1, name='pCylA' )
cmds.polyCut( 'pCylA.f[0:59]', cd='Y', ch=1 )

# Delete the bottom half of the cylinder
#
cmds.select( cl=True )
cmds.polyCylinder( r=1, h=2, sx=20, sy=1, sz=1, ax=(0, 1, 0), cuv=1, ch=1, name='pCylB' )
cmds.move( 3, 0, 0, r=True )
cmds.polyCut( 'pCylB.f[0:59]', cd='Y', df=1, ch=1 )
cmds.select( cl=True )


# Split the bottom half of the cylinder
#
cmds.select( cl=True )
cmds.polyCylinder( r=1, h=2, sx=20, sy=1, sz=1, ax=(0, 1, 0), cuv=1, ch=1, name='pCylC' )
cmds.move( 6, 0, 0, r=True )
cmds.polyCut( 'pCylC.f[0:59]', cd='Y', ef=1, ch=1 )

# select one of the cylinders, and select the polyCut node from the
# channel box, and enter the showManipulator Tool, on the Toolbar.
# You can interactively place the cutting plane, and the result of
# cut operation will adjust accordingly.