SoClipPlane(3IV)

NAME
     SoClipPlane (SoClpPln) - clipping plane node

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoClipPlane

SYNOPSIS
     #include <Inventor_c/nodes/SoClipPlane.h>

     typedef SoClipPlane  SoClpPln

          Fields from class SoClipPlane:

     SoSFPlane           plane
     SoSFBool            on

          Functions from class SoClipPlane:

     SoClipPlane *       SoClpPlnCreate()
     SoType              SoClpPlnGetClassTypeId()

          Functions from class SoNode:

     void                SoClpPlnSetOverride(SoClpPln *this, SbBool state)
     SbBool              SoClpPlnIsOverride(const SoClpPln *this)
     SoNode *            SoClpPlnCopy(const SoClpPln *this, SbBool
                              copyConnections = FALSE)
     SbBool              SoClpPlnAffectsState(const SoClpPln *this)
     SoNode *            SoClpPlnGetByName(const char *name)
     int                 SoClpPlnGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoClpPlnSetToDflts(SoClpPln *this)
     SbBool              SoClpPlnHasDfltVals(const SoClpPln *this)
     SbBool              SoClpPlnFldsAreEq(const SoClpPln *this, const
                              SoFieldContainer *fc)
     void                SoClpPlnCopyFieldVals(SoClpPln *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoClpPlnSet(SoClpPln *this, const char
                              *fieldDataString)
     void                SoClpPlnGet(SoClpPln *this, SbString
                              *fieldDataString)
     int                 SoClpPlnGetFields(const SoClpPln *this, SoFieldList
                              *resultList)
     SoField *           SoClpPlnGetField(const SoClpPln *this, const char
                              *fieldName)
     SbBool              SoClpPlnGetFieldName(const SoClpPln *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoClpPlnIsNotifyEnabled(const SoClpPln *this)
     SbBool              SoClpPlnEnableNotify(SoClpPln *this, SbBool flag)

          Functions from class SoBase:

     void                SoClpPlnRef(SoClpPln *this)
     void                SoClpPlnUnref(const SoClpPln *this)
     void                SoClpPlnUnrefNoDelete(const SoClpPln *this)
     void                SoClpPlnTouch(SoClpPln *this)
     SoType              SoClpPlnGetTypeId(const SoClpPln *this)
     SbBool              SoClpPlnIsOfType(const SoClpPln *this, SoType type)
     void                SoClpPlnSetName(SoClpPln *this, const char *name)
     SbName              SoClpPlnGetName(const SoClpPln *this)


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

FIELDS
     SoSFPlane           plane
          Plane defining half-space.

     SoSFBool            on
          Whether clipping plane is active.


FUNCTIONS
     SoClipPlane *       SoClpPlnCreate()
          Creates a clip plane node with default settings.

     SoType              SoClpPlnGetClassTypeId()
          Returns type identifier for this class.


ACTION BEHAVIOR
     SoGLRenderAction, SoCallbackAction, SoRayPickAction
          Adds the plane to the current list of clipping planes in the state.


FILE FORMAT/DEFAULTS
     ClipPlane {
          plane  1 0 0  0
          on     TRUE
     }
SEE ALSO
     SoCamera, SoShapeHints