SoSFPlane(3IV)

NAME
     SoSFPlane (SoSPlane) - field containing a plane equation

INHERITS FROM
     SoField > SoSField > SoSFPlane

SYNOPSIS
     #include <Inventor_c/fields/SoSFPlane.h>

     typedef SoSFPlane   SoSPlane

          Functions from class SoSFPlane:

     SoType              SoSPlaneGetClassTypeId()
     void                SoSPlaneGetTypeId(const SoSPlane *this)
     const SbPlane *     SoSPlaneGet(const SoSPlane *this)
     void                SoSPlaneSet(SoSPlane *this, const SbPlane * newValue)
     int                 SoSPlaneIsEq(const SoSPlane *this, const SoSFPlane
                              *f)
     int                 SoSPlaneIsNEq(const SoSPlane *this, const SoSFPlane
                              *f)

          Functions from class SoField:

     void                SoSPlaneSetIgnored(SoSPlane *this, SbBool ignore)
     SbBool              SoSPlaneIsIgnored(const SoSPlane *this)
     SbBool              SoSPlaneIsDflt(const SoSPlane *this)
     SbBool              SoSPlaneIsOfType(const SoSPlane *this, SoType type)
     SbBool              SoSPlaneSetFromStr(SoSPlane *this, const char
                              *valueString)
     void                SoSPlaneGetIntoStr(SoSPlane *this, SbString
                              *valueString)
     void                SoSPlaneTouch(SoSPlane *this)
     SbBool              SoSPlaneConnFromField(SoSPlane *this, SoField
                              *fromField)
     SbBool              SoSPlaneConnFrom(SoSPlane *this, SoEngineOutput
                              *fromEngine)
     void                SoSPlaneDisconn(SoSPlane *this)
     SbBool              SoSPlaneIsConn(const SoSPlane *this)
     SbBool              SoSPlaneIsConnFromField(const SoSPlane *this)
     SbBool              SoSPlaneGetConnField(const SoSPlane *this, SoField
                              **writingField)
     SbBool              SoSPlaneIsConnFromEngine(const SoSPlane *this)
     SbBool              SoSPlaneGetConnEngine(const SoSPlane *this,
                              SoEngineOutput **engineOutput)
     void                SoSPlaneEnableConn(SoSPlane *this, SbBool flag)
     SbBool              SoSPlaneIsConnEnabled(const SoSPlane *this)
     int                 SoSPlaneGetForwardConn(const SoSPlane *this,
                              SoFieldList *list)
     SoFieldContainer *  SoSPlaneGetContainer(const SoSPlane *this)
DESCRIPTION
     A field containing a plane equation (an SbPlane).

     SoSFPlanes are written to file as four floating point values separated by
     whitespace. The first three are the normal direction of the plane, the
     fourth is the distance of the plane from the origin (in the direction of
     the normal).

FUNCTIONS
     SoType              SoSPlaneGetClassTypeId()
     void                SoSPlaneGetTypeId(const SoSPlane *this)
          Returns the type for this class or a particular object of this
          class.

     const SbPlane *     SoSPlaneGet(const SoSPlane *this)
          Returns this field's value.

     void                SoSPlaneSet(SoSPlane *this, const SbPlane * newValue)
          Sets this field to newValue.

     int                 SoSPlaneIsEq(const SoSPlane *this, const SoSFPlane
                              *f)
     int                 SoSPlaneIsNEq(const SoSPlane *this, const SoSFPlane
                              *f)
          Returns TRUE if f is of the same type and has the same value as this
          field.


SEE ALSO
     SbPlane, SoField, SoSField, SoMFPlane