Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoMFColorRGBA Class Reference

The SoMFColorRGBA class is a container for SbColor4f values. More...

#include <Inventor/fields/SoMFColorRGBA.h>

Inheritance diagram for SoMFColorRGBA:
SoMField SoField

Public Member Functions

virtual SoType getTypeId (void) const
 
virtual void copyFrom (const SoField &field)
 
const SoMFColorRGBAoperator= (const SoMFColorRGBA &field)
 
virtual SbBool isSame (const SoField &field) const
 
const SbColor4foperator[] (const int idx) const
 
const SbColor4fgetValues (const int start) const
 
int find (const SbColor4f &value, SbBool addifnotfound=FALSE)
 
void setValues (const int start, const int num, const SbColor4f *newvals)
 
void set1Value (const int idx, const SbColor4f &value)
 
void setValue (const SbColor4f &value)
 
const SbColor4foperator= (const SbColor4f &val)
 
SbBool operator== (const SoMFColorRGBA &field) const
 
SbBool operator!= (const SoMFColorRGBA &field) const
 
SbColor4fstartEditing (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 SbColor4f *userdata)
 
void setValuesPointer (const int num, SbColor4f *userdata)
 
void setValues (int start, int num, const float rgba[][4])
 
void setHSVValues (int start, int num, const float hsv[][4])
 
void setValue (const SbVec4f &vec)
 
void setValue (float r, float g, float b, float a)
 
void setValue (const float rgba[4])
 
void setHSVValue (float h, float s, float v, float a)
 
void setHSVValue (const float hsva[4])
 
void set1Value (int idx, const SbVec4f &vec)
 
void set1Value (int idx, float r, float g, float b, float a)
 
void set1Value (int idx, const float rgba[4])
 
void set1HSVValue (int idx, float h, float s, float v, float a)
 
void set1HSVValue (int idx, const float hsva[4])
 
- Public Member Functions inherited from SoMField
virtual ~SoMField ()
 
int getNum (void) const
 
void setNum (const int num)
 
virtual void deleteValues (int start, int num=-1)
 
virtual void insertSpace (int start, int num)
 
SbBool set1 (const int index, const char *const valuestring)
 
void get1 (const int index, SbString &valuestring)
 
virtual void enableDeleteValues (void)
 
virtual SbBool isDeleteValuesEnabled (void) const
 
- Public Member Functions inherited from SoField
virtual ~SoField ()
 
void setIgnored (SbBool ignore)
 
SbBool isIgnored (void) const
 
void setDefault (SbBool defaultVal)
 
SbBool isDefault (void) const
 
SbBool isOfType (const SoType type) const
 
void enableConnection (SbBool flag)
 
SbBool isConnectionEnabled (void) const
 
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
 
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
 
void disconnect (SoEngineOutput *engineoutput)
 
SbBool isConnectedFromEngine (void) const
 
SbBool getConnectedEngine (SoEngineOutput *&master) const
 
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
 
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
 
void disconnect (SoField *field)
 
SbBool isConnectedFromField (void) const
 
SbBool getConnectedField (SoField *&master) const
 
int getNumConnections (void) const
 
int getForwardConnections (SoFieldList &slavelist) const
 
int getConnections (SoFieldList &masterlist) const
 
void disconnect (void)
 
SbBool isConnected (void) const
 
void setContainer (SoFieldContainer *cont)
 
SoFieldContainergetContainer (void) const
 
SbBool set (const char *valuestring)
 
void get (SbString &valuestring)
 
SbBool shouldWrite (void) const
 
virtual void touch (void)
 
virtual void startNotify (void)
 
virtual void notify (SoNotList *nlist)
 
SbBool enableNotify (SbBool on)
 
SbBool isNotifyEnabled (void) const
 
void addAuditor (void *f, SoNotRec::Type type)
 
void removeAuditor (void *f, SoNotRec::Type type)
 
int operator== (const SoField &f) const
 
int operator!= (const SoField &f) const
 
virtual void connectionStatusChanged (int numconnections)
 
SbBool isReadOnly (void) const
 
virtual void fixCopy (SbBool copyconnections)
 
virtual SbBool referencesCopy (void) const
 
void copyConnection (const SoField *fromfield)
 
virtual SbBool read (SoInput *input, const SbName &name)
 
virtual void write (SoOutput *out, const SbName &name) const
 
virtual void countWriteRefs (SoOutput *out) const
 
void setFieldType (int type)
 
int getFieldType (void) const
 
SbBool getDirty (void) const
 
void setDirty (SbBool dirty)
 
void evaluate (void) 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 SoType getClassTypeId (void)
 
static void atexit_cleanup (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoField
static void initClass (void)
 
static void initClasses (void)
 
static void cleanupClass (void)
 
static SoType getClassTypeId (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 Member Functions inherited from SoMField
 SoMField (void)
 
virtual void makeRoom (int newnum)
 
virtual SoNotRec createNotRec (SoBase *container)
 
void setChangedIndex (const int chgidx)
 
void setChangedIndices (const int chgidx=-1, const int numchgind=0)
 
- Protected Member Functions inherited from SoField
 SoField (void)
 
void valueChanged (SbBool resetdefault=TRUE)
 
virtual void evaluateConnection (void) const
 
virtual SbBool readConnection (SoInput *in)
 
virtual void writeConnection (SoOutput *out) const
 
SbBool isDestructing (void) const
 

Protected Attributes

SbColor4fvalues
 
- Protected Attributes inherited from SoMField
int num
 
int maxNum
 
SbBool userDataIsUsed
 

Additional Inherited Members

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

Detailed Description

The SoMFColorRGBA class is a container for SbColor4f 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
SbColor4f, SoSFColorRGBA

Member Function Documentation

◆ getTypeId()

SoType SoMFColorRGBA::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.

◆ copyFrom()

void SoMFColorRGBA::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.

◆ isSame()

SbBool SoMFColorRGBA::isSame ( const SoField f) const
virtual

Check for equal type and value(s).

Implements SoField.

◆ deleteAllValues()

void SoMFColorRGBA::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.

◆ copyValue()

void SoMFColorRGBA::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 contructors where necessary.

Implements SoMField.

◆ getValues()

const SbColor4f* SoMFColorRGBA::getValues ( const int  start) const
inline

Returns a pointer to the values array.

◆ setValues()

void SoMFColorRGBA::setValues ( int  start,
int  numarg,
const float  rgba[][4] 
)

Set num RGB color values, starting at index start.

◆ setHSVValues()

void SoMFColorRGBA::setHSVValues ( int  start,
int  numarg,
const float  hsva[][4] 
)

Set num HSV color values, starting at index start.

◆ setValue() [1/3]

void SoMFColorRGBA::setValue ( const SbVec4f 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() [2/3]

void SoMFColorRGBA::setValue ( float  r,
float  g,
float  b,
float  a 
)

Set the color array to a single value. r, g and b are the red, green and blue components, respectively.

◆ setValue() [3/3]

void SoMFColorRGBA::setValue ( const float  rgba[4])

Set the color array to a single value. rgb is a three element vector with the red, green and blue components, respectively.

◆ setHSVValue() [1/2]

void SoMFColorRGBA::setHSVValue ( float  h,
float  s,
float  v,
float  a 
)

Set the color array to a single value. h, s and v are the hue, saturation and value components, respectively.

◆ setHSVValue() [2/2]

void SoMFColorRGBA::setHSVValue ( const float  hsva[4])

Set the color array to a single value. hsv is a three element vector with the hue, saturation and value components, respectively.

◆ set1Value() [1/3]

void SoMFColorRGBA::set1Value ( int  idx,
const SbVec4f vec 
)

Set the color at idx. vec is interpreted as a three element vector with the red, green and blue components, respectively.

◆ set1Value() [2/3]

void SoMFColorRGBA::set1Value ( int  idx,
float  r,
float  g,
float  b,
float  a 
)

Set the color at idx. r, g and b is the red, green and blue components, respectively.

◆ set1Value() [3/3]

void SoMFColorRGBA::set1Value ( int  idx,
const float  rgba[4] 
)

Set the color at idx. rgb is interpreted as a three element vector with the red, green and blue components, respectively.

◆ set1HSVValue() [1/2]

void SoMFColorRGBA::set1HSVValue ( int  idx,
float  h,
float  s,
float  v,
float  a 
)

Set the color at idx. h, s and v is the hue, saturation and value components, respectively.

◆ set1HSVValue() [2/2]

void SoMFColorRGBA::set1HSVValue ( int  idx,
const float  hsva[4] 
)

Set the color at idx. hsv is a three element vector with the hue, saturation and value components, respectively.


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