sosfcolorrgba(3)

NAME

SoSFColorRGBA

SYNOPSIS

#include <Inventor/fields/SoSFColorRGBA.h>
Inherits SoSField.

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
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])
Static Public Member Functions
static void * createInstance (void)
static SoType getClassTypeId (void) static void initClass (void)
Protected Attributes
SbColor4f value

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.
Referenced by SoField::initClasses().
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().

Author

Generated automatically by Doxygen for Coin from the source code.
Copyright © 2010-2025 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout