Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
SoSFColorRGBA Class Reference
Field Classes

The SoSFColorRGBA class is a container for an SbColor4f value. More...

#include <Inventor/fields/SoSFColorRGBA.h>

Inheritance diagram for SoSFColorRGBA:
SoSField SoField

Public Member Functions

virtual void copyFrom (const SoField &field)
 
virtual SoType getTypeId (void) const
 
const SbColor4f & getValue (void) const
 
virtual SbBool isSame (const SoField &field) const
 
int operator!= (const SoSFColorRGBA &field) const
 
const SbColor4f & operator= (const SbColor4f &newvalue)
 
const SoSFColorRGBA & operator= (const SoSFColorRGBA &field)
 
int operator== (const SoSFColorRGBA &field) const
 
void setHSVValue (const float hsva[4])
 
void setHSVValue (float h, float s, float v, float a)
 
void setValue (const float rgba[4])
 
void setValue (const SbColor4f &newvalue)
 
void setValue (const SbVec4f &vec)
 
void setValue (float red, float green, float blue, float alpha)
 
- Public Member Functions inherited from SoSField
virtual ~SoSField ()
 
- 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 SoSField
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 Attributes

SbColor4f value
 

Additional Inherited Members

- Public Types inherited from SoField
enum  FieldType { NORMAL_FIELD = 0 , EVENTIN_FIELD , EVENTOUT_FIELD , EXPOSED_FIELD }
 
- Protected Member Functions inherited from SoSField
 SoSField (void)
 
- Protected Member Functions inherited from SoField
 SoField (void)
 
virtual SoNotRec createNotRec (SoBase *cont)
 
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
 

Detailed Description

The SoSFColorRGBA class is a container for an SbColor4f value.

This field is used where nodes, engines or other field containers need to store a single color value (i.e. Red + Green + Blue + Alpha).

Fields of this type stores their value to file as a "R G B A" quadruple component, where each color component value is between 0.0 and 1.0.

See also
SbColor4f, SoMFColorRGBA

Member Function Documentation

◆ copyFrom()

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

◆ createInstance()

void * SoSFColorRGBA::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.

◆ getClassTypeId()

SoType SoSFColorRGBA::getClassTypeId ( void )
static

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

◆ getTypeId()

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

◆ initClass()

void SoSFColorRGBA::initClass ( void )
static

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

◆ isSame()

SbBool SoSFColorRGBA::isSame ( const SoField & f) const
virtual

Check for equal type and value(s).

Implements SoField.

◆ setHSVValue() [1/2]

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

Set color value from a floating point number array with three elements. The three elements will be interpreted as hue, saturation and value, respectively.

◆ setHSVValue() [2/2]

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

Set color value from h, s and v, where is "hue", s is "saturation" and v is "value".

◆ setValue() [1/3]

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

Set color value from a floating point number array with three elements. The three elements will be interpreted as red, green and blue, respectively.

◆ setValue() [2/3]

void SoSFColorRGBA::setValue ( const SbVec4f & vec)

Set color value from a vector with three elements. The three elements will be interpreted as red, green and blue, respectively.

◆ setValue() [3/3]

void SoSFColorRGBA::setValue ( float red,
float green,
float blue,
float alpha )

Set color value from red, green and blue. Value range for each component is between 0.0 and 1.0.

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