SoMFColor Class Reference
[Fields]

Multiple-value field containing any number of RGB colors stored as three floats. More...

#include <Inventor/fields/SoMFColor.h>

Inheritance diagram for SoMFColor:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
const SoMFColor &	operator= (const SoMFColor &f)
	SoMFColor ()
virtual	~SoMFColor ()
SbColor *	startEditing ()
void	finishEditing ()
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)
void	setValue (const SbColor &newValue)
const SbColor &	operator= (const SbColor &newValue)
int	operator== (const SoMFColor &f) const
int	operator!= (const SoMFColor &f) const
virtual void	enableDeleteValues ()
virtual void	disableDeleteValues ()
virtual SbBool	isDeleteValuesEnabled ()
virtual size_t	getValueSize () const
void	setValuesPointer (int num, const float *userData)
void	setValuesPointer (int num, float *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 index, const SbVec3f &vec)
void	set1Value (int index, float r, float g, float b)
void	set1Value (int index, const float rgb[3])
void	set1HSVValue (int index, float h, float s, float v)
void	set1HSVValue (int index, const float hsv[3])
Static Public Member Functions
static SoType	getClassTypeId ()

---

Detailed Description

Multiple-value field containing any number of RGB colors stored as three floats.

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.

Data copying:

SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

SEE ALSO

SbColor

---

Constructor & Destructor Documentation

SoMFColor::SoMFColor

(

)

Default constructor.

virtual SoMFColor::~SoMFColor

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void SoMFColor::disableDeleteValues

(

)

[inline, virtual]

Temporary disable value deleting.

virtual void SoMFColor::enableDeleteValues

(

)

[inline, virtual]

Sets the enableDeleteValues flag.

This flag (if TRUE) allows Open Inventor to destroy the user data array given to setValuesPointer(). This user data array will be managed exactly like internal field data values. Default is FALSE.

int SoMFColor::find	(	const SbColor &	targetValue,
		SbBool	addIfNotFound = FALSE
	)

Finds the given targetValue 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 SoMFColor::finishEditing

(

)

[inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFColor::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFColor::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbColor* SoMFColor::getValues

(

int

start

)

const [inline]

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.

virtual size_t SoMFColor::getValueSize

(

)

const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFColor::isDeleteValuesEnabled

(

)

[inline, virtual]

Returns FALSE if user data array has been given to.

setValuesPointer() and enableDeleteValues() has never been called, and memory for data has not been reallocated. Otherwise, returns TRUE.

int SoMFColor::operator!=

(

const SoMFColor &

f

)

const [inline]

Returns TRUE if all of the values of this field do not equal.

those of the given f. If the fields are different types TRUE will always be returned.

Reimplemented from SoField.

const SbColor& SoMFColor::operator=

(

const SbColor &

newValue

)

[inline]

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

const SoMFColor& SoMFColor::operator=

(

const SoMFColor &

f

)

Copy from another field of same type.

int SoMFColor::operator==

(

const SoMFColor &

f

)

const

Returns TRUE if all of the values of this field equal those of.

the given f. If the fields are different types FALSE will always be returned.

Reimplemented from SoField.

const SbColor& SoMFColor::operator[]

(

int

i

)

const [inline]

Returns the i'th value of the field.

Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

void SoMFColor::set1HSVValue	(	int	index,
		const float	hsv[3]
	)

Sets one of N HSV colors from an array of 3 floats.

The array will be expanded and filled with zeros as necessary.

void SoMFColor::set1HSVValue	(	int	index,
		float	h,
		float	s,
		float	v
	)

Sets one of N HSV colors from 3 floats.

The array will be expanded and filled with zeros as necessary.

void SoMFColor::set1Value	(	int	index,
		const float	rgb[3]
	)

Sets one of N RGB colors from an array of 3 floats.

The array will be expanded and filled with zeros as necessary.

void SoMFColor::set1Value	(	int	index,
		float	r,
		float	g,
		float	b
	)

Sets one of N RGB colors from 3 floats.

The array will be expanded and filled with zeros as necessary.

void SoMFColor::set1Value	(	int	index,
		const SbVec3f &	vec
	)

Sets one of N RGB colors from SbVec3f.

The array will be expanded and filled with zeros as necessary.

void SoMFColor::set1Value	(	int	index,
		const SbColor &	newValue
	)

Sets the index'th value in the array to newValue.

The array will be automatically expanded, if necessary.

void SoMFColor::setHSVValue

(

const float

hsv[3]

)

Sets the field to contain one and only one value, the given color (expressed as an array of HSV floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values.

void SoMFColor::setHSVValue	(	float	h,
		float	s,
		float	v
	)

Sets the field to contain one and only one value, the given color (expressed as HSV floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values.

void SoMFColor::setHSVValues	(	int	start,
		int	num,
		const float	hsv[][3]
	)

Sets num HSV values from an array of arrays of 3 floats.

Each float should be in the range 0.0 to 1.0, and there must be 3* num floats in the array.

void SoMFColor::setValue

(

const float

rgb[3]

)

Sets the field to contain one and only one value, the given color (expressed as an array of RGB floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values.

void SoMFColor::setValue	(	float	r,
		float	g,
		float	b
	)

Sets the field to contain one and only one value, the given color (expressed as RGB floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values.

void SoMFColor::setValue

(

const SbVec3f &

vec

)

Sets the field to contain one and only one value, the given color (expressed as RGB floating point values in the range 0.0 to 1.0), and deletes the second and subsequent values.

void SoMFColor::setValue

(

const SbColor &

newValue

)

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

void SoMFColor::setValues	(	int	start,
		int	num,
		const float	rgb[][3]
	)

Sets num RGB values from an array of arrays of 3 floats.

Each float should be in the range 0.0 to 1.0, and there must be 3* num floats in the array.

void SoMFColor::setValues	(	int	start,
		int	num,
		const SbColor *	newValues
	)

Sets num values starting at index start to the values.

in newValues. The array will automatically be made larger to accommodate the new values, if necessary.

void SoMFColor::setValuesPointer	(	int	num,
		float *	userData
	)

See setValuesPointer(int, const float *).

void SoMFColor::setValuesPointer	(	int	num,
		const float *	userData
	)

Sets the field to contain the num values stored in userData array.

This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).

SbColor* SoMFColor::startEditing

(

)

[inline]

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.

---

The documentation for this class was generated from the following file:

• Inventor/fields/SoMFColor.h