Clip SOP

From TouchDesigner 088 Wiki

12 ClipSOP.jpg

Summary

The Clip SOP cuts and creases source geometry with a plane.

PythonIcon.png clipSOP_Class

Parameters

Group - If there are input groups, specifying a group name in this field will cause this SOP to act only upon the group specified. Accepts patterns, as described in Pattern Matching in the Scripting Guide.

Keep - Options controlling what part of the clip to keep:

  • Primitives Above the Plane - Retain the primitives above the cutting plane.
  • Primitives Below the Plane - Retain the primitives below the cutting plane.
  • All Primitives - Retain both the top and bottom primitives generated by the cutting plane. Creates a crease in the geometry.

Distance /dist - Allows you to move the cutting plane along the Direction vector. If the Direction (plane's normal) is 0 1 0, putting a positive number in the Distance field moves the plane up in Y.

Direction /dirx /diry /dirz The default values of 0 1 0 creates a Normal vector straight up in Y, which is perpendicular to the XZ plane, which becomes the clipping plane. 1 0 0 points the normal in positive X, giving a clipping plane in YZ. The plane may be positioned at an angle by using values typed in (1 1 0 gives a 45 angle plane) or interactively by using the direction vector jack.

Create Groups - When checked, allows you to generate specific groups for the geometry above and below the cutting plane. See the two group option fields below. This option is only available when All Primitives are kept.

Above Plane - When Create Groups is checked, you can assign the geometry below the cutting plane to the Group name typed in this field.

Below Plane - When Create Groups is checked, you can assign the geometry above the cutting plane to the Group name typed in this field.

Inputs / Geometry Type

This SOP accepts one input. The Clip SOP will attempt to clip all primitives. If the primitive type when clipped does not destroy the primitives structure, it will be clipped, i.e. polygons, particle systems. Others are deleted if they are intersected by the clipping plane.

Uses / Works in Relation With

This SOP can be used to clip out polygons outside the field of view to reduce the number of primitives in a given scene.