Man Linux: Main Page and Category List

NAME

       SoMFColor -

       The SoMFColor class is a container for SbColor values.

       This field is used where nodes, engines or other field containers needs
       to store multiple color values (i.e. ’Red Green Blue’ triplets).

SYNOPSIS

       #include <Inventor/fields/SoMFColor.h>

       Inherits SoMField.

   Public Member Functions
       virtual SoType getTypeId (void) const
       virtual void copyFrom (const SoField &field)
       const SoMFColor & operator= (const SoMFColor &field)
       virtual SbBool isSame (const SoField &field) const
       PRIVATE_MFIELD_IO_HEADER ()
       const SbColor & operator[] (const int idx) const
       const SbColor * getValues (const int start) const
       int find (const SbColor &value, SbBool addifnotfound=0)
       void setValues (const int start, const int num, const SbColor *newvals)
       void set1Value (const int idx, const SbColor &value)
       void setValue (const SbColor &value)
       const SbColor & operator= (const SbColor &val)
       SbBool operator== (const SoMFColor &field) const
       SbBool operator!= (const SoMFColor &field) const
       SbColor * startEditing (void)
       void finishEditing (void)
       void setValuesPointer (const int num, const float *userdata)
       void setValuesPointer (const int num, float *userdata)
       void setValuesPointer (const int num, const SbColor *userdata)
       void setValuesPointer (const int num, SbColor *userdata)
       void setValues (int start, int num, const float rgb[][3])
       void setHSVValues (int start, int num, const float hsv[][3])
       void setValue (const SbVec3f &vec)
       void setValue (float r, float g, float b)
       void setValue (const float rgb[3])
       void setHSVValue (float h, float s, float v)
       void setHSVValue (const float hsv[3])
       void set1Value (int idx, const SbVec3f &vec)
       void set1Value (int idx, float r, float g, float b)
       void set1Value (int idx, const float rgb[3])
       void set1HSVValue (int idx, float h, float s, float v)
       void set1HSVValue (int idx, const float hsv[3])

   Static Public Member Functions
       static void * createInstance (void)
       static SoType getClassTypeId (void)
       static void initClass (void)

   Protected Member Functions
       virtual void deleteAllValues (void)
       virtual void copyValue (int to, int from)
       virtual int fieldSizeof (void) const
       virtual void * valuesPtr (void)
       virtual void setValuesPtr (void *ptr)
       virtual void allocValues (int num)

   Protected Attributes
       SbColor * values

Detailed Description

       The SoMFColor class is a container for SbColor values.

       This field is used where nodes, engines or other field containers needs
       to store multiple color values (i.e. ’Red Green Blue’ triplets).

       This field supports application data sharing through a
       setValuesPointer() method. See SoMField documentation for information
       on how to use this function.

       See also:
           SbColor, SoSFColor

Member Function Documentation

   static SoType SoMFColor::getClassTypeId (void) [static] Returns a unique
       type identifier for this field class.
       See also:
           getTypeId(), SoType

       Reimplemented from SoMField.

   virtual SoType SoMFColor::getTypeId (void) const [virtual] Returns the type
       identification instance which uniquely identifies the Coin field class
       the object belongs to.
       See also:
           getClassTypeId(), SoType

       Implements SoField.

   virtual void SoMFColor::copyFrom (const SoField & f) [virtual] Copy
       value(s) from f into this field. f must be of the same type as this
       field.
       Implements SoField.

   virtual SbBool SoMFColor::isSame (const SoField & f) const [virtual] Check
       for equal type and value(s).
       Implements SoField.

   const SbColor* SoMFColor::getValues (const int start) const [inline]
        Returns a pointer to the values array. .SS "void SoMFColor::initClass
       (void) [static]"Internal method called upon initialization of the
       library (from SoDB::init()) to set up the type system.
       Reimplemented from SoMField.

   void SoMFColor::setValues (int start, int numarg, const float rgb[][3]) Set
       num RGB color values, starting at index start.
   void SoMFColor::setHSVValues (int start, int numarg, const float hsv[][3])
       Set num HSV color values, starting at index start.
   void SoMFColor::setValue (const SbVec3f & vec) Set the color array to a
       single value. vec is interpreted as a three element vector with the
       red, green and blue components, respectively.
   void SoMFColor::setValue (float r, float g, float b) Set the color array to
       a single value. r, g and b are the red, green and blue components,
       respectively.
   void SoMFColor::setValue (const float rgb[3]) Set the color array to a
       single value. rgb is a three element vector with the red, green and
       blue components, respectively.
   void SoMFColor::setHSVValue (float h, float s, float v) Set the color array
       to a single value. h, s and v are the hue, saturation and value
       components, respectively.
   void SoMFColor::setHSVValue (const float hsv[3]) Set the color array to a
       single value. hsv is a three element vector with the hue, saturation
       and value components, respectively.
   void SoMFColor::set1Value (int idx, const SbVec3f & vec) Set the color at
       idx. vec is interpreted as a three element vector with the red, green
       and blue components, respectively.
   void SoMFColor::set1Value (int idx, float r, float g, float b) Set the
       color at idx. r, g and b is the red, green and blue components,
       respectively.
   void SoMFColor::set1Value (int idx, const float rgb[3]) Set the color at
       idx. rgb is interpreted as a three element vector with the red, green
       and blue components, respectively.
   void SoMFColor::set1HSVValue (int idx, float h, float s, float v) Set the
       color at idx. h, s and v is the hue, saturation and value components,
       respectively.
   void SoMFColor::set1HSVValue (int idx, const float hsv[3]) Set the color at
       idx. hsv is a three element vector with the hue, saturation and value
       components, respectively.

Author

       Generated automatically by Doxygen for Coin from the source code.