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

Public Member Functions | Static Public Member Functions | Protected Attributes
SoSFColorRGBA Class Reference

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:
SoSField SoField

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFColorRGBAoperator= (const SoSFColorRGBA &field)
virtual SbBool isSame (const SoField &field) const
const SbColor4fgetValue (void) const
void setValue (const SbColor4f &newvalue)
const SbColor4foperator= (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 def)
SbBool isDefault (void) const
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0)
SbBool appendConnection (SoField *master, SbBool notnotify=0)
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 *in, 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)

Protected Attributes

SbColor4f value

Additional Inherited Members

- Protected Member Functions inherited from SoSField
 SoSField (void)
- Protected Member Functions inherited from SoField
 SoField (void)
void valueChanged (SbBool resetdefault=1)
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
Since:
Coin 2.5

Member Function Documentation

SoType SoSFColorRGBA::getClassTypeId ( void  )
static

Returns a unique type identifier for this field class.

See also:
getTypeId(), SoType

Reimplemented from SoSField.

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.

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.

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

Check for equal type and value(s).

Implements SoField.

void SoSFColorRGBA::initClass ( void  )
static

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

Reimplemented from SoSField.

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.

References SbColor4f::setValue(), and SoField::valueChanged().

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.

References SbColor4f::setValue(), and SoField::valueChanged().

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.

References SbColor4f::setValue(), and SoField::valueChanged().

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".

References SbColor4f::setHSVValue(), and SoField::valueChanged().

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.

References SbColor4f::setHSVValue(), and SoField::valueChanged().


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

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

Generated on Thu Jul 19 2012 for Coin by Doxygen. 1.8.1.1