| http://www.sim.no/ http://www.coin3d.org/

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.This field is used where nodes, engines or other field containers needs to store a single color value (i.e. Red + Green + Blue + Alpha). More...

`#include <Inventor/fields/SoSFColorRGBA.h>`

Inheritance diagram for SoSFColorRGBA:

## Public Member Functions

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

## Detailed Description

The SoSFColorRGBA class is a container for an SbColor4f value.

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

## ◆ getTypeId()

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

## ◆ isSame()

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

virtual

Check for equal type and value(s).

Implements SoField.

## ◆ setValue() [1/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() [2/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.

## ◆ setValue() [3/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.

## ◆ setHSVValue() [1/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".

## ◆ setHSVValue() [2/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.

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

- SoSFColorRGBA.h
- SoSFColorRGBA.cpp

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.