SoMFColorRGBA Class Reference
[Fields]

Multiple-value field containing any number of RGBA colors stored as four floats. More...

#include <Inventor/fields/SoMFColorRGBA.h>

Inheritance diagram for SoMFColorRGBA:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFColorRGBA & operator= (const SoMFColorRGBA &f)
 SoMFColorRGBA ()
virtual ~SoMFColorRGBA ()
SbColorRGBA * startEditing ()
void finishEditing ()
const SbColorRGBA & operator[] (int i) const
const SbColorRGBA * getValues (int start) const
int find (const SbColorRGBA &targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SbColorRGBA *newValues)
void set1Value (int index, const SbColorRGBA &newValue)
void setValue (const SbColorRGBA &newValue)
const SbColorRGBA & operator= (const SbColorRGBA &newValue)
int operator== (const SoMFColorRGBA &f) const
int operator!= (const SoMFColorRGBA &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 rgba[][4])
void setHSVAValues (int start, int num, const float hsva[][4])
void setValue (const SbVec4f &vec)
void setValue (float r, float g, float b, float a)
void setValue (const float rgba[4])
void setHSVAValue (float h, float s, float v, float a)
void setHSVAValue (const float hsva[4])
void set1Value (int index, const SbVec4f &vec)
void set1Value (int index, float r, float g, float b, float a)
void set1Value (int index, const float rgba[4])
void set1HSVAValue (int index, float h, float s, float v, float a)
void set1HSVAValue (int index, const float hsva[4])

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Multiple-value field containing any number of RGBA colors stored as four floats.

A multiple-value field that contains any number of RGBA colors, stored as instances of SbColorRGBA. RGBA stands for red, green, blue and alpha. Values should be in the range 0 to 1. Alpha is the inverse of "transparency", in other words 0 is fully transparent and 1 is fully opaque.

Values can also be specified or queried in the HSV (hue, saturation and value) color space, but values are stored internally as RGBA values.

SoMFColorRGBAs are written to file as one or more RGBA quadruples 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.5, 0 1 0 1, 0 0 1 .25 ]

represents the three colors half transparent red, fully opeque green, and one quarter transparent 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

SbColorRGBA

Constructor & Destructor Documentation

SoMFColorRGBA::SoMFColorRGBA (  ) 

Default constructor.

virtual SoMFColorRGBA::~SoMFColorRGBA (  )  [virtual]

Destructor.

Member Function Documentation

virtual void SoMFColorRGBA::disableDeleteValues (  )  [inline, virtual]

Temporary disable value deleting.

virtual void SoMFColorRGBA::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 SoMFColorRGBA::find ( const SbColorRGBA &  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 SoMFColorRGBA::finishEditing (  )  [inline]

Indicates that batch edits have finished.

See startEditing().

static SoType SoMFColorRGBA::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

virtual SoType SoMFColorRGBA::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbColorRGBA* SoMFColorRGBA::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 SoMFColorRGBA::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

virtual SbBool SoMFColorRGBA::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 SoMFColorRGBA::operator!= ( const SoMFColorRGBA &  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 SbColorRGBA& SoMFColorRGBA::operator= ( const SbColorRGBA &  newValue  )  [inline]

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

the second and subsequent values.

const SoMFColorRGBA& SoMFColorRGBA::operator= ( const SoMFColorRGBA &  f  ) 

Copy from another field of same type.

int SoMFColorRGBA::operator== ( const SoMFColorRGBA &  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 SbColorRGBA& SoMFColorRGBA::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 SoMFColorRGBA::set1HSVAValue ( int  index,
const float  hsva[4] 
)

Sets one of N HSV plus Alpha colors from an array of 4 floats.

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

void SoMFColorRGBA::set1HSVAValue ( int  index,
float  h,
float  s,
float  v,
float  a 
)

Sets one of N HSV plus Alpha colors from 4 floats.

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

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

Sets one of N RGBA colors from an array of 4 floats.

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

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

Sets one of N RGBA colors from 4 floats.

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

void SoMFColorRGBA::set1Value ( int  index,
const SbVec4f &  vec 
)

Sets one of N RGBA colors from SbVec4f.

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

void SoMFColorRGBA::set1Value ( int  index,
const SbColorRGBA &  newValue 
)

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

The array will be automatically expanded, if necessary.

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

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

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

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

void SoMFColorRGBA::setHSVAValues ( int  start,
int  num,
const float  hsva[][4] 
)

Sets num HSV (hue, saturation and value) plus Alphe color values from an array of arrays of 4 floats.

Each float should be in the range 0.0 to 1.0, and there must be 4* num total float values.

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

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

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

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

void SoMFColorRGBA::setValue ( const SbVec4f &  vec  ) 

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

void SoMFColorRGBA::setValue ( const SbColorRGBA &  newValue  ) 

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

the second and subsequent values.

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

Sets num RGBA values from an array of arrays of 4 floats.

Each float should be in the range 0.0 to 1.0, and there must be 4* num total float values.

void SoMFColorRGBA::setValues ( int  start,
int  num,
const SbColorRGBA *  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 SoMFColorRGBA::setValuesPointer ( int  num,
float *  userData 
)

See setValuesPointer(int, const float *).

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

SbColorRGBA* SoMFColorRGBA::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:
Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/