Coin Logo http://www.sim.no
http://www.coin3d.org

SoMFColorRGBA Class Reference
[Field classes]

The SoMFColorRGBA class is a container for SbColor4f values.

This field is used where nodes, engines or other field containers needs to store multiple color values (i.e. "Red Green Blue" triplets). More...

#include <Inventor/fields/SoMFColorRGBA.h>

Inheritance diagram for SoMFColorRGBA:

SoMField SoField

List of all members.

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=0)
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])

Static Public Member Functions

static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (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 Attributes

SbColor4fvalues


Detailed Description

The SoMFColorRGBA class is a container for SbColor4f values.

This field is used where nodes, engines or other field containers needs 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
Since:
Coin 2.5

Member Function Documentation

SoType SoMFColorRGBA::getClassTypeId ( void   )  [static]

Returns a unique type identifier for this field class.

See also:
getTypeId(), SoType

Reimplemented from SoMField.

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.

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.

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

Check for equal type and value(s).

Implements SoField.

void SoMFColorRGBA::deleteAllValues ( void   )  [protected, virtual]

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

Implements SoMField.

void SoMFColorRGBA::copyValue ( int  to,
int  from 
) [protected, virtual]

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.

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

\ Returns a pointer to the values array. \

void SoMFColorRGBA::initClass ( void   )  [static]

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

Reimplemented from SoMField.

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

Set num RGB color values, starting at index start.

References SoMField::makeRoom(), SoMField::maxNum, SoMField::num, and SoField::valueChanged().

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

Set num HSV color values, starting at index start.

References SoMField::makeRoom(), SoMField::maxNum, SoMField::num, setHSVValue(), and SoField::valueChanged().

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.

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.

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.

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.

References SbColor4f::setHSVValue().

Referenced by setHSVValue(), and setHSVValues().

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.

References setHSVValue().

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.

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.

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.

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.

References SbColor4f::setHSVValue().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:33:53 2009 for Coin by Doxygen. 1.5.8