Provided by: inventor-doc_2.1.5-10-18_all bug

NAME

       SoSFColor — field containing an RGB color

INHERITS FROM

       SoField > SoSField > SoSFColor

SYNOPSIS

          Methods from class SoSFColor:

     void                setValue(const SbVec3f &vec)
     void                setValue(float red, float green, float blue)
     void                setValue(const float rgb[3])
     void                setHSVValue(float hue, float saturation, float value)
     void                setHSVValue(const float hsv[3])
     static SoType       getClassTypeId()
     virtual void        getTypeId() const
     const SbColor &     getValue() const
     const SbColor &     operator =(const SbColor & newValue)
     void                setValue(const SbColor & newValue)
     int                 operator ==(const SoSFColor &f) const
     int                 operator !=(const SoSFColor &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  single-value  field containing an SbColor. Values may be set in either RGB (red, green,
       blue) or HSV (hue, saturation, value) color spaces.

       SoSFColors are written to file as an RGB triple of  floating  point  numbers  in  standard
       scientific notation, in the range 0.0 to 1.0.

METHODS

     void                setValue(const SbVec3f &vec)
     void                setValue(float red, float green, float blue)
     void                setValue(const float rgb[3])
     void                setHSVValue(float hue, float saturation, float value)
     void                setHSVValue(const float hsv[3])
          Convenience methods for setting the value.

     static SoType       getClassTypeId()
     virtual void        getTypeId() const
          Returns the type for this class or a particular object of this class.

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

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

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

SEE ALSO

       SoField, SoSField, SoMFColor, SbColor

                                                                                 SoSFColor(3IV)()