SoMFColor Class Reference

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

#include <Inventor/fields/SoMFColor.h>

Inheritance diagram for SoMFColor:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
const SoMFColor &	operator= (const SoMFColor &f)
	Copy from another field of same type.
	SoMFColor ()
	Default constructor.
virtual	~SoMFColor ()
	Destructor.
SbColor *	startEditing ()
	Returns a pointer to the internally maintained array that can be modified.
void	finishEditing ()
	Indicates that batch edits have finished.
const SbColor &	operator[] (int i) const
	Returns the i'th value of the field.
const SbColor *	getValues (int start) const
	Returns a pointer into the array of values in the field, starting at index start.
int	find (const SbColor &targetValue, SbBool addIfNotFound=FALSE)
	Finds the given targetValue in the array and returns the index of that value.
void	setValues (int start, int num, const SbColor *newValues)
	Sets num values starting at index start to the values.
void	set1Value (int index, const SbColor &newValue)
	Sets the index'th value in the array to newValue.
void	setValue (const SbColor &newValue)
	Sets the first value in the array to newValue, and deletes.
const SbColor &	operator= (const SbColor &newValue)
	Sets the first value in the array to newValue, and deletes.
int	operator== (const SoMFColor &f) const
	Returns TRUE if all of the values of this field equal those of.
int	operator!= (const SoMFColor &f) const
	Returns TRUE if all of the values of this field do not equal.
virtual void	enableDeleteValues ()
	Sets the enableDeleteValues flag.
virtual void	disableDeleteValues ()
	Temporary disable value deleting.
virtual SbBool	isDeleteValuesEnabled ()
	Returns FALSE if user data array has been given to
virtual size_t	getValueSize () const
	Get size of the value.
void	setValuesPointer (int num, const float *userData)
	Sets the field to contain the num values stored in userData array.
void	setValuesPointer (int num, float *userData)
	See setValuesPointer(int, const float *)
void	setValues (int start, int num, const float rgb[][3])
	Sets num RGB values from an array of arrays of 3 floats.
void	setHSVValues (int start, int num, const float hsv[][3])
	Sets num HSV values from an array of arrays of 3 floats.
void	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	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	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	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	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	set1Value (int index, const SbVec3f &vec)
	Sets one of N RGB colors from SbVec3f.
void	set1Value (int index, float r, float g, float b)
	Sets one of N RGB colors from 3 floats.
void	set1Value (int index, const float rgb[3])
	Sets one of N RGB colors from an array of 3 floats.
void	set1HSVValue (int index, float h, float s, float v)
	Sets one of N HSV colors from 3 floats.
void	set1HSVValue (int index, const float hsv[3])
	Sets one of N HSV colors from an array of 3 floats.
Public Member Functions inherited from SoMField
int	getNum () const
	Returns the number of values currently in the field.
void	setNum (int num)
	Forces this field to have exactly num values, inserting or deleting values as necessary.
virtual void	deleteValues (int start, int num=-1)
	Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created).
virtual void	insertSpace (int start, int num)
	Inserts space for num values at index start .
SoNONUNICODE SbBool	set1 (int index, const char *valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.
SbBool	set1 (int index, const SbString &valueString)
	This is equivalent to the set() method of SoField, but operates on only one value.
void	get1 (int index, SbString &valueString)
	This is equivalent to the get() method of SoField, but operates on only one value.
Public Member Functions inherited from SoField
void	setIgnored (SbBool ig)
	Sets the ignore flag for this field.
SbBool	isIgnored () const
	Gets the ignore flag for this field.
SbBool	isDefault () const
	Gets the state of default flag of the field.
void	enableConnection (SbBool flag)
	Field connections may be enabled and disabled.
SbBool	isConnectionEnabled () const
	Returns FALSE if connections to this field are disabled.
SbBool	connectFrom (SoEngineOutput *engineOutput)
	Connects this field from an engine output.
SbBool	connectFrom (SoField *field)
	Connects this field to another field.
SbBool	connectFrom (SoVRMLInterpOutput *interpOutput)
	Connects this field from an interpOutput.
SbBool	appendConnection (SoEngineOutput *engineOutput)
	Appends this field to the list of connections from another engineOutput.
SbBool	appendConnection (SoField *field)
	Appends this field to the list of connections from another field.
SbBool	appendConnection (SoVRMLInterpOutput *interpOutput)
	Appends this field to the list of connections from another interpOutput.
void	disconnect (SoEngineOutput *engineOutput)
	Disconnect the field from the requested engineOutput.
void	disconnect (SoField *field)
	Disconnect the field from the requested field.
void	disconnect (SoVRMLInterpOutput *interpOutput)
	Disconnect the field from the requested interpOutput.
int	getNumConnections () const
	Returns the number of connections to this field.
int	getConnections (SoFieldList &list)
	Returns a list of the connections to this field.
void	disconnect ()
	Disconnect the field from whatever it was connected to.
SbBool	isConnected () const
	Returns TRUE if the field is connected to anything.
SbBool	isConnectedFromVRMLInterp () const
	Returns TRUE if the field is connected to a VRML interpOutput.
SbBool	isConnectedFromEngine () const
	Returns TRUE if the field is connected to an engine's output.
SbBool	isConnectedFromField () const
	Returns TRUE if the field is connected to another field.
SbBool	getConnectedEngine (SoEngineOutput *&engineOutput) const
	Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
SbBool	getConnectedField (SoField *&writingField) const
	Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
SbBool	getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
	Returns the VRMLInterpolator output field is connected to.
int	getForwardConnections (SoFieldList &list) const
	Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
SoFieldContainer *	getContainer () const
	Returns the object that contains this field.
SoNONUNICODE SbBool	set (const char *valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
SbBool	set (const SbString &valueString)
	Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
void	get (SbString &valueString)
	Returns the value of the field in the Open Inventor file format, even if the field has its default value.
virtual void	touch ()
	Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
int	operator== (const SoField &f) const
	Return TRUE if this field is of the same type and has the same value as f.
int	operator!= (const SoField &f) const
	Return FALSE if this field is of the same type and has the same value as f.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoMField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.
Static Public Member Functions inherited from SoField
static SoType	getClassTypeId ()
	Return the type identifier for this field class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

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

Definition at line 98 of file SoMFColor.h.

Constructor & Destructor Documentation

SoMFColor()

SoMFColor::SoMFColor

(

)

Default constructor.

~SoMFColor()

virtual SoMFColor::~SoMFColor ( )

virtual

Destructor.

Member Function Documentation

disableDeleteValues()

virtual void SoMFColor::disableDeleteValues ( )

inlinevirtual

Temporary disable value deleting.

Definition at line 100 of file SoMFColor.h.

enableDeleteValues()

virtual void SoMFColor::enableDeleteValues ( )

inlinevirtual

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.

Definition at line 100 of file SoMFColor.h.

find()

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).

finishEditing()

void SoMFColor::finishEditing ( )

inline

Indicates that batch edits have finished.

See startEditing().

Definition at line 100 of file SoMFColor.h.

getClassTypeId()

static SoType SoMFColor::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoMFColor::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

getValues()

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.

Definition at line 100 of file SoMFColor.h.

getValueSize()

virtual size_t SoMFColor::getValueSize ( ) const

inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 100 of file SoMFColor.h.

isDeleteValuesEnabled()

virtual SbBool SoMFColor::isDeleteValuesEnabled ( )

inlinevirtual

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.

Definition at line 100 of file SoMFColor.h.

operator!=()

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.

Definition at line 100 of file SoMFColor.h.

operator=() [1/2]

const SbColor & SoMFColor::operator= ( const SbColor &  newValue )

inline

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

the second and subsequent values.

Definition at line 100 of file SoMFColor.h.

operator=() [2/2]

const SoMFColor & SoMFColor::operator=

(

const SoMFColor &

f

)

Copy from another field of same type.

operator==()

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.

operator[]()

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.

Definition at line 100 of file SoMFColor.h.

set1HSVValue() [1/2]

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.

set1HSVValue() [2/2]

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.

set1Value() [1/4]

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.

set1Value() [2/4]

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.

set1Value() [3/4]

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.

set1Value() [4/4]

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.

setHSVValue() [1/2]

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.

setHSVValue() [2/2]

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.

setHSVValues()

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.

setValue() [1/4]

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.

setValue() [2/4]

void SoMFColor::setValue

(

const SbColor &

newValue

)

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

the second and subsequent values.

setValue() [3/4]

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.

setValue() [4/4]

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.

setValues() [1/2]

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.

setValues() [2/2]

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.

setValuesPointer() [1/2]

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).

setValuesPointer() [2/2]

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

See setValuesPointer(int, const float *)

startEditing()

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.

Definition at line 100 of file SoMFColor.h.

---

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

• Inventor/fields/SoMFColor.h