Provided by: inventor-doc_2.1.5-10+dfsg-2.1build2_all 
NAME
SoMFColor — multiple-value field containing any number of RGB colors stored as three
floats
INHERITS FROM
SoField > SoMField > SoMFColor
SYNOPSIS
Methods from class SoMFColor:
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 red, float green, float blue)
void setHSVValue(float hue, float saturation, float value)
void setValue(const float rgb[3])
void setHSVValue(const float hsv[3])
void set1Value(index, const SbVec3f &vec)
void set1Value(index, float r, float g, float b)
void set1HSVValue(index, float h, float s, float v)
void set1Value(index, const float rgb[3])
void set1HSVValue(index, const float hsv[3])
static SoType getClassTypeId()
virtual void getTypeId() const
const SbColor & operator [](int i) const
const SbColor * getValues(int start) const
int find(const SbColor & targetValue, SbBool addIfNotFound = FALSE)
void setValues(int start, int num, const SbColor *newValues)
void set1Value(int index, const SbColor & newValue)
const SbColor & operator =(const SbColor & newValue)
void setValue(const SbColor & newValue)
int operator ==(const SoMFColor &f) const
int operator !=(const SoMFColor &f) const
SbColor * startEditing()
void finishEditing()
Methods from class SoMField:
int getNum() const
void setNum(int num)
virtual void deleteValues(int start, int num = -1)
virtual void insertSpace(int start, int num)
SbBool set1(int index, const char *valueString)
void get1(int index, SbString &valueString)
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 multiple-value field that contains any number of RGB colors, stored as instances of
SbColor. Values may be set in either RGB (red, green, blue) or HSV (hue, saturation,
value) color spaces.
SoMFColors are written to file as one or more RGB triples of floating point numbers in
standard scientific notation. When more than one value is present, all of the values are
enclosed in square brackets and separated by commas. For example:
[ 1.0 0.0 0.0, 0 1 0, 0 0 1 ]
represents the three colors red, green, and blue.
METHODS
void setValues(int start, int num, const float rgb[][3])
void setHSVValues(int start, int num, const float hsv[][3])
Sets num values starting at index start to the RGB (or HSV) values specified by the
given array of floats. Each float should be in the range 0.0 to 1.0, and there must be
3*num floats in the array.
void setValue(const SbVec3f &vec)
void setValue(float red, float green, float blue)
void setHSVValue(float hue, float saturation, float value)
void setValue(const float rgb[3])
void setHSVValue(const float hsv[3])
Sets the field to contain one and only one value, the given color (expressed as either
RGB or HSV floating point values in the range 0.0 to 1.0), and deletes the second and
subsequent values.
void set1Value(index, const SbVec3f &vec)
void set1Value(index, float r, float g, float b)
void set1HSVValue(index, float h, float s, float v)
void set1Value(index, const float rgb[3])
void set1HSVValue(index, const float hsv[3])
Sets one value in the array to the given color. The array will be expanded and filled
with zeroes as necessary.
static SoType getClassTypeId()
virtual void getTypeId() const
Returns the type for this class or a particular object of this class.
const SbColor & operator [](int i) const
Returns the i'th value of the field. Indexing past the end of the field (passing in i
greater than getNum()) will return garbage.
const SbColor * getValues(int start) const
Returns a pointer into the array of values in the field, starting at index start. The
values are read-only; see the startEditing()/finishEditing() methods for a way of
modifying values in place.
int find(const SbColor & targetValue, SbBool addIfNotFound = FALSE)
Finds the given value in the array and returns the index of that value in the array. If
the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is
added to the end of the array (but -1 is still returned).
void setValues(int start, int num, const SbColor *newValues)
Sets num values starting at index start to the values in newValues. The array will be
automatically be made larger to accomodate the new values, if necessary.
void set1Value(int index, const SbColor & newValue)
Sets the index'th value in the array to newValue. The array will be automatically
expanded, if necessary.
const SbColor & operator =(const SbColor & newValue)
void setValue(const SbColor & newValue)
Sets the first value in the array to newValue, and deletes the second and subsequent
values.
int operator ==(const SoMFColor &f) const
int operator !=(const SoMFColor &f) const
Returns TRUE if all of the values of this field equal (do not equal) those of the given
field. If the fields are different types FALSE will always be returned (even if one
field is an SoMFFloat with one value of 1.0 and the other is an SoMFInt with a value of
1, for example).
SbColor * startEditing()
void finishEditing()
startEditing() returns a pointer to the internally-maintained array that can be
modified. The values in the array may be changed, but values cannot be added or
removed. It is illegal to call any other editing methods between startEditing() and
finishEditing() (e.g. set1Value(), setValue(), etc).
Fields, engines or sensors connected to this field and sensors are not notified that
this field has changed until finishEditing() is called. Calling finishEditing() always
sets the isDefault() flag to FALSE and informs engines and sensors that the field
changed, even if none of the values actually were changed.
SEE ALSO
SbColor
SoMFColor(3IV)()