Go to: Synopsis. Return value. Related. Flags. MEL 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]

polyCut is undoable, queryable, and editable.

This command splits a mesh, or a set of poly faces, along a plane. The position and orientation of the plane can be adjusted using the appropriate flags listed above. In addition, the cut operation can also delete the faces lying on one side of the cutting plane, or extract those faces by an offset amount.

Return value

string The node name.

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

Related

polySplit, polySubdivideEdge

Flags

caching, constructionHistory, cutPlaneCenter, cutPlaneCenterX, cutPlaneCenterY, cutPlaneCenterZ, cutPlaneHeight, cutPlaneRotate, cutPlaneRotateX, cutPlaneRotateY, cutPlaneRotateZ, cutPlaneSize, cutPlaneWidth, cuttingDirection, deleteFaces, extractFaces, extractOffset, extractOffsetX, extractOffsetY, extractOffsetZ, name, nodeState, worldSpace
Long name (short name) Argument types Properties
-deleteFaces(-df) boolean create
This flag specifies if the cut faces should be deleted or not.
-extractFaces(-ef) boolean create
This flag specifies if the cut faces should be extracted or not.
-extractOffset(-eo) linear linear linear create
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 create
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 create
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 create
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.
-cuttingDirection(-cd) string create
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.
-cutPlaneCenter(-pc) linear linear linear create
This flag specifies the position of the cutting plane.
-cutPlaneCenterX(-pcx) linear create
This flag specifies the X position of the cutting plane.
-cutPlaneCenterY(-pcy) linear create
This flag specifies the Y position of the cutting plane.
-cutPlaneCenterZ(-pcz) linear create
This flag specifies the Z position of the cutting plane.
-cutPlaneRotate(-ro) angle angle angle create
This flag specifies the orientation of the cutting plane.
-cutPlaneRotateX(-rx) angle create
This flag specifies the X rotation of the cutting plane.
-cutPlaneRotateY(-ry) angle create
This flag specifies the Y rotation of the cutting plane.
-cutPlaneRotateZ(-rz) angle create
This flag specifies the Z rotation of the cutting plane.
-cutPlaneSize(-ps) linear linear create
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.
-cutPlaneHeight(-ph) linear create
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.
-cutPlaneWidth(-pw) linear create
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.
-worldSpace(-ws) boolean create
This flag is ignored. polyCut command always works on worldSpace.
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 be used more than once in a command.

MEL examples

// Introduce new edges at the middle of a cylinder
//
polyCylinder -r 1 -h 2 -sx 20 -sy 1 -sz 1 -ax 0 1 0 -cuv 1 -ch 1 -name pCylA;
polyCut -cd "Y" -ch 1 pCylA.f[0:59];

// Delete the bottom half of the cylinder
//
select -cl;
polyCylinder -r 1 -h 2 -sx 20 -sy 1 -sz 1 -ax 0 1 0 -cuv 1 -ch 1 -name pCylB;
move -r 3 0 0 ;
polyCut -cd "Y" -df 1 -ch 1 pCylB.f[0:59];
select -cl;


// Split the bottom half of the cylinder
//
select -cl;
polyCylinder -r 1 -h 2 -sx 20 -sy 1 -sz 1 -ax 0 1 0 -cuv 1 -ch 1 -name pCylC;
move -r 6 0 0 ;
polyCut -cd "Y" -ef 1 -ch 1 pCylC.f[0:59];

// 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.