SoSFColor(3IV)

SoSFColor (SoSCol) - field containing an RGB color

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

NAME
     SoSFColor (SoSCol) - field containing an RGB color

INHERITS FROM
     SoField > SoSField > SoSFColor

SYNOPSIS
     typedef SoSFColor   SoSCol

          Functions from class SoSFColor:

     void                SoSColSetV3f(SoSCol *this, const SbVec3f *vec)
     void                SoSColSetR_G_B(SoSCol *this, float red, float green,
                              float blue)
     void                SoSColSetRGB(SoSCol *this, const float rgb[3])
     void                SoSColSetH_S_V(SoSCol *this, float hue, float
                              saturation, float value)
     void                SoSColSetHSV(SoSCol *this, const float hsv[3])
     SoType              SoSColGetClassTypeId()
     void                SoSColGetTypeId(const SoSCol *this)
     const SbColor *     SoSColGet(const SoSCol *this)
     void                SoSColSet(SoSCol *this, const SbColor * newValue)
     int                 SoSColIsEq(const SoSCol *this, const SoSFColor *f)
     int                 SoSColIsNEq(const SoSCol *this, const SoSFColor *f)

          Functions from class SoField:

     void                SoSColSetIgnored(SoSCol *this, SbBool ignore)
     SbBool              SoSColIsIgnored(const SoSCol *this)
     SbBool              SoSColIsDflt(const SoSCol *this)
     SbBool              SoSColIsOfType(const SoSCol *this, SoType type)
     SbBool              SoSColSetFromStr(SoSCol *this, const char
                              *valueString)
     void                SoSColGetIntoStr(SoSCol *this, SbString *valueString)
     void                SoSColTouch(SoSCol *this)
     SbBool              SoSColConnFromField(SoSCol *this, SoField *fromField)
     SbBool              SoSColConnFrom(SoSCol *this, SoEngineOutput
                              *fromEngine)
     void                SoSColDisconn(SoSCol *this)
     SbBool              SoSColIsConn(const SoSCol *this)
     SbBool              SoSColIsConnFromField(const SoSCol *this)
     SbBool              SoSColGetConnField(const SoSCol *this, SoField
                              **writingField)
     SbBool              SoSColIsConnFromEngine(const SoSCol *this)
     SbBool              SoSColGetConnEngine(const SoSCol *this,
                              SoEngineOutput **engineOutput)
     void                SoSColEnableConn(SoSCol *this, SbBool flag)
     SbBool              SoSColIsConnEnabled(const SoSCol *this)
     int                 SoSColGetForwardConn(const SoSCol *this, SoFieldList
                              *list)
     SoFieldContainer *  SoSColGetContainer(const SoSCol *this)
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.

FUNCTIONS
     void                SoSColSetV3f(SoSCol *this, const SbVec3f *vec)
     void                SoSColSetR_G_B(SoSCol *this, float red, float green,
                              float blue)
     void                SoSColSetRGB(SoSCol *this, const float rgb[3])
     void                SoSColSetH_S_V(SoSCol *this, float hue, float
                              saturation, float value)
     void                SoSColSetHSV(SoSCol *this, const float hsv[3])
          Convenience methods for setting the value.

     SoType              SoSColGetClassTypeId()
     void                SoSColGetTypeId(const SoSCol *this)
          Returns the type for this class or a particular object of this
          class.

     const SbColor *     SoSColGet(const SoSCol *this)
          Returns this field's value.

     void                SoSColSet(SoSCol *this, const SbColor * newValue)
          Sets this field to newValue.

     int                 SoSColIsEq(const SoSCol *this, const SoSFColor *f)
     int                 SoSColIsNEq(const SoSCol *this, const SoSFColor *f)
          Returns TRUE if f is of the same type and has the same value as this
          field.


SEE ALSO
     SoField, SoSField, SoMFColor, SbColor