The SoMFColor class is a container for SbColor values. More...

#include <Inventor/fields/SoMFColor.h>

Inheritance diagram for SoMFColor:

Public Member Functions
virtual void	copyFrom (const SoField &field)

int	find (const SbColor &value, SbBool addifnotfound=FALSE)

void	finishEditing (void)

virtual SoType	getTypeId (void) const

const SbColor *	getValues (const int start) const

virtual SbBool	isSame (const SoField &field) const

SbBool	operator!= (const SoMFColor &field) const

const SbColor &	operator= (const SbColor &val)

const SoMFColor &	operator= (const SoMFColor &field)

SbBool	operator== (const SoMFColor &field) const

const SbColor &	operator[] (const int idx) const

void	set1HSVValue (int idx, const float hsv[3])

void	set1HSVValue (int idx, float h, float s, float v)

void	set1Value (const int idx, const SbColor &value)

void	set1Value (int idx, const float rgb[3])

void	set1Value (int idx, const SbVec3f &vec)

void	set1Value (int idx, float r, float g, float b)

void	setHSVValue (const float hsv[3])

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

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

void	setValue (const float rgb[3])

void	setValue (const SbColor &value)

void	setValue (const SbVec3f &vec)

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

void	setValues (const int start, const int num, const SbColor *newvals)

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

void	setValuesPointer (const int num, const float *userdata)

void	setValuesPointer (const int num, const SbColor *userdata)

void	setValuesPointer (const int num, float *userdata)

void	setValuesPointer (const int num, SbColor *userdata)

SbColor *	startEditing (void)

Public Member Functions inherited from SoMField
virtual	~SoMField ()

virtual void	deleteValues (int start, int num=-1)

virtual void	enableDeleteValues (void)

void	get1 (const int index, SbString &valuestring)

int	getNum (void) const

virtual void	insertSpace (int start, int num)

virtual SbBool	isDeleteValuesEnabled (void) const

SbBool	set1 (const int index, const char *const valuestring)

void	setNum (const int num)

Public Member Functions inherited from SoField
virtual	~SoField ()

void	addAuditor (void *f, SoNotRec::Type type)

SbBool	appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)

SbBool	appendConnection (SoField *master, SbBool notnotify=FALSE)

SbBool	connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)

SbBool	connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)

virtual void	connectionStatusChanged (int numconnections)

void	copyConnection (const SoField *fromfield)

virtual void	countWriteRefs (SoOutput *out) const

void	disconnect (SoEngineOutput *engineoutput)

void	disconnect (SoField *field)

void	disconnect (void)

void	enableConnection (SbBool flag)

SbBool	enableNotify (SbBool on)

void	evaluate (void) const

virtual void	fixCopy (SbBool copyconnections)

void	get (SbString &valuestring)

SbBool	getConnectedEngine (SoEngineOutput *&master) const

SbBool	getConnectedField (SoField *&master) const

int	getConnections (SoFieldList &masterlist) const

SoFieldContainer *	getContainer (void) const

SbBool	getDirty (void) const

int	getFieldType (void) const

int	getForwardConnections (SoFieldList &slavelist) const

int	getNumConnections (void) const

SbBool	isConnected (void) const

SbBool	isConnectedFromEngine (void) const

SbBool	isConnectedFromField (void) const

SbBool	isConnectionEnabled (void) const

SbBool	isDefault (void) const

SbBool	isIgnored (void) const

SbBool	isNotifyEnabled (void) const

SbBool	isOfType (const SoType type) const

SbBool	isReadOnly (void) const

virtual void	notify (SoNotList *nlist)

int	operator!= (const SoField &f) const

int	operator== (const SoField &f) const

virtual SbBool	read (SoInput *input, const SbName &name)

virtual SbBool	referencesCopy (void) const

void	removeAuditor (void *f, SoNotRec::Type type)

SbBool	set (const char *valuestring)

void	setContainer (SoFieldContainer *cont)

void	setDefault (SbBool defaultVal)

void	setDirty (SbBool dirty)

void	setFieldType (int type)

void	setIgnored (SbBool ignore)

SbBool	shouldWrite (void) const

virtual void	startNotify (void)

virtual void	touch (void)

virtual void	write (SoOutput *out, const SbName &name) const

Static Public Member Functions
static void *	createInstance (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoMField
static void	atexit_cleanup (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoField
static void	cleanupClass (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

static void	initClasses (void)

Protected Member Functions
virtual void	allocValues (int num)

virtual void	copyValue (int to, int from)

virtual void	deleteAllValues (void)

virtual int	fieldSizeof (void) const

virtual void	setValuesPtr (void *ptr)

virtual void *	valuesPtr (void)

Protected Member Functions inherited from SoMField
	SoMField (void)

virtual SoNotRec	createNotRec (SoBase *container)

virtual void	makeRoom (int newnum)

void	setChangedIndex (const int chgidx)

void	setChangedIndices (const int chgidx=-1, const int numchgind=0)

Protected Member Functions inherited from SoField
	SoField (void)

virtual void	evaluateConnection (void) const

SbBool	isDestructing (void) const

virtual SbBool	readConnection (SoInput *in)

void	valueChanged (SbBool resetdefault=TRUE)

virtual void	writeConnection (SoOutput *out) const

Protected Attributes
SbColor *	values

Protected Attributes inherited from SoMField
int	maxNum

int	num

SbBool	userDataIsUsed

Additional Inherited Members
Public Types inherited from SoField
enum	FieldType { NORMAL_FIELD = 0 , EVENTIN_FIELD , EVENTOUT_FIELD , EXPOSED_FIELD }

Detailed Description

The SoMFColor class is a container for SbColor values.

This field is used where nodes, engines or other field containers need 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

◆ copyFrom()

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.

◆ copyValue()

void SoMFColor::copyValue	(	int	to,
		int	from )

protectedvirtual

This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy constructors where necessary.

Implements SoMField.

◆ createInstance()

void * SoMFColor::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

◆ deleteAllValues()

void SoMFColor::deleteAllValues ( void )

protectedvirtual

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoMField.

◆ getClassTypeId()

SoType SoMFColor::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getTypeId()

SoType SoMFColor::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and "downward" casting.

Implements SoField.

◆ getValues()

const SbColor * SoMFColor::getValues ( const int start ) const

inline

Returns a pointer to the values array.

◆ initClass()

void SoMFColor::initClass ( void )

static

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

◆ isSame()

SbBool SoMFColor::isSame ( const SoField & f ) const

virtual

Check for equal type and value(s).

Implements SoField.

◆ set1HSVValue() [1/2]

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.

◆ set1HSVValue() [2/2]

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.

◆ set1Value() [1/3]

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.

◆ set1Value() [2/3]

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.

◆ set1Value() [3/3]

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.

◆ setHSVValue() [1/2]

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.

◆ setHSVValue() [2/2]

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.

◆ setHSVValues()

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

Set num HSV color values, starting at index start.

◆ setValue() [1/3]

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.

◆ setValue() [2/3]

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.

◆ setValue() [3/3]

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.

◆ setValues()

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

Set num RGB color values, starting at index start.

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

SoMFColor.h
SoMFColor.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyFrom()

◆ copyValue()

◆ createInstance()

◆ deleteAllValues()

◆ getClassTypeId()

◆ getTypeId()

◆ getValues()

◆ initClass()

◆ isSame()

◆ set1HSVValue() [1/2]

◆ set1HSVValue() [2/2]

◆ set1Value() [1/3]

◆ set1Value() [2/3]

◆ set1Value() [3/3]

◆ setHSVValue() [1/2]

◆ setHSVValue() [2/2]

◆ setHSVValues()

◆ setValue() [1/3]

◆ setValue() [2/3]

◆ setValue() [3/3]

◆ setValues()