Class SoClipPlane

  • All Implemented Interfaces:
    Direct Known Subclasses:

    public class SoClipPlane
    extends SoNode
    Clipping plane node. This node clips all subsequent shapes in the scene graph to the half-space defined by the plane field. The half-space is the side of the plane in the direction of the plane normal. For example, if the plane is positioned at the origin and the normal is pointing down the positive X axis, everything in the negative X space will be clipped away.

    Any number of clipping planes may be active simultaneously, although the graphics library may place a limit on this number during rendering.

    For an interactive version of this node, see class SoClipPlaneManip. Also see the clip plane dragger example in the Resources section of the Open Inventor Forum: (registration is required to view this section of the forum).

    File format/default:

    ClipPlane {

      plane 1 0 0 0
      on true

    Action behavior:

    SoGLRenderAction, SoCallbackAction, SoRayPickAction
    Adds the plane to the current list of clipping planes in the state. Sets: SoClipPlaneElement

    See Also:
    SoCamera, SoShapeHints, SoClipPlaneManip
    • Field Detail

      • plane

        public final SoSFPlane plane
        Plane defining half-space.
      • on

        public final SoSFBool on
        Whether clipping plane is active.
    • Constructor Detail

      • SoClipPlane

        public SoClipPlane()
        Creates a clip plane node with default settings.