table of contents
SoSFColor(3) | Library Functions Manual | SoSFColor(3) |
NAME¶
SoSFColor - The SoSFColor class is a container for an SbColor value.
SYNOPSIS¶
#include <Inventor/fields/SoSFColor.h>
Inherits SoSField.
Public Member Functions¶
virtual SoType getTypeId (void)
const
virtual void copyFrom (const SoField
&field)
const SoSFColor & operator= (const
SoSFColor &field)
virtual SbBool isSame (const SoField
&field) const
const SbColor & getValue (void) const
void setValue (const SbColor &newvalue)
const SbColor & operator= (const
SbColor &newvalue)
int operator== (const SoSFColor &field)
const
int operator!= (const SoSFColor &field)
const
void setValue (const SbVec3f &vec)
void setValue (float red, float green, float blue)
void setValue (const float rgb[3])
void setHSVValue (float h, float s, float v)
void setHSVValue (const float hsv[3])
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¶
SbColor 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 SoSFColor class is a container for an SbColor value.
This field is used where nodes, engines or other field containers needs to store a single color value (i.e. Red + Green + Blue).
Fields of this type stores their value to file as a 'R G B' triple component, where each color component value is between 0.0 and 1.0.
See also
Member Function Documentation¶
SoType SoSFColor::getTypeId (void) const [virtual]¶
Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.
See also
Implements SoField.
void SoSFColor::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 SoSFColor::isSame (const SoField & f) const [virtual]¶
Check for equal type and value(s).
Implements SoField.
void SoSFColor::setValue (const SbVec3f & vec)¶
Set color value from a vector with three elements. The three elements will be interpreted as red, green and blue, respectively.
void SoSFColor::setValue (float red, float green, float blue)¶
Set color value from red, green and blue. Value range for each component is between 0.0 and 1.0.
void SoSFColor::setValue (const float rgb[3])¶
Set color value from a floating point number array with three elements. The three elements will be interpreted as red, green and blue, respectively.
void SoSFColor::setHSVValue (float h, float s, float v)¶
Set color value from h, s and v, where is 'hue', s is 'saturation' and v is 'value'.
void SoSFColor::setHSVValue (const float hsv[3])¶
Set color value from a floating point number array with three elements. The three elements will be interpreted as hue, saturation and value, respectively.
Author¶
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 | Coin |