SoSFPlane(3IV)

SoSFPlane - field containing a plane equation

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.22.

NAME
     SoSFPlane - field containing a plane equation

INHERITS FROM
     SoField > SoSField > SoSFPlane

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

          Methods from class SoSFPlane:

     static SoType       getClassTypeId()
     virtual void        getTypeId() const
     const SbPlane &     getValue() const
     const SbPlane &     operator =(const SbPlane & newValue)
     void                setValue(const SbPlane & newValue)
     int                 operator ==(const SoSFPlane &f) const
     int                 operator !=(const SoSFPlane &f) const

          Methods from class SoField:

     void                setIgnored(SbBool ignore)
     SbBool              isIgnored() const
     SbBool              isDefault() const
     virtual SbBool      isOfType(SoType type) const
     SbBool              set(const char *valueString)
     void                get(SbString &valueString)
     void                touch()
     SbBool              connectFrom(SoField *fromField)
     SbBool              connectFrom(SoEngineOutput *fromEngine)
     void                disconnect()
     SbBool              isConnected() const
     SbBool              isConnectedFromField() const
     SbBool              getConnectedField(SoField *&writingField) const
     SbBool              isConnectedFromEngine() const
     SbBool              getConnectedEngine(SoEngineOutput *&engineOutput)
                              const
     void                enableConnection(SbBool flag)
     SbBool              isConnectionEnabled() const
     int                 getForwardConnections(SoFieldList &list) const
     SoFieldContainer *  getContainer() const


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).
METHODS
     static SoType       getClassTypeId()
     virtual void        getTypeId() const
          Returns the type for this class or a particular object of this
          class.

     const SbPlane &     getValue() const
          Returns this field's value.

     const SbPlane &     operator =(const SbPlane & newValue)
     void                setValue(const SbPlane & newValue)
          Sets this field to newValue.

     int                 operator ==(const SoSFPlane &f) const
     int                 operator !=(const SoSFPlane &f) const
          Returns TRUE if f is of the same type and has the same value as this
          field.


SEE ALSO
     SbPlane, SoField, SoSField, SoMFPlane