![]() |
http://www.sim.no http://www.coin3d.org |
The SbColor4f class contains the red, green, blue and alpha components which make up a color value. More...
#include <Inventor/SbColor4f.h>
Friends | |
SbColor4f | operator* (const SbColor4f &c, const float d) |
SbColor4f | operator* (const float d, const SbColor4f &c) |
SbColor4f | operator/ (const SbColor4f &c, const float d) |
SbColor4f | operator+ (const SbColor4f &v1, const SbColor4f &v2) |
SbColor4f | operator- (const SbColor4f &v1, const SbColor4f &v2) |
int | operator== (const SbColor4f &v1, const SbColor4f &v2) |
int | operator!= (const SbColor4f &v1, const SbColor4f &v2) |
The SbColor4f class contains the red, green, blue and alpha components which make up a color value.
This class is used internally within other classes in Coin. It contains a 4 component vector as a position in the RGB cube with an additional transparency value.
The red, green and blue values should be between 0.0 and 1.0, where 0.0 is interpreted as minimum intensity, and 1.0 is maximum intensity. The transparency value is also between 0.0 and 1.0.
SbColor4f contains methods for convenient handling of setting and getting color values as 32 bit packed values or as HSV values.
Note: this class is not part of Open Inventor, but is an extension to the API. Don't use it if you want your code to be compatible with Open Inventor.
SbColor4f::SbColor4f | ( | void | ) |
Default constructor. The color value will be uninitialized until explicitly set.
Construct and initialize an SbColor4f with the red, green, blue and alpha values given by the v
vector.
Construct and initialize an SbColor4f with the red, green, blue and alpha taken from given rgba
array
Construct and initialize an SbColor4f with the given red, green, blue and alpha values.
Set a new color.
Referenced by setPackedValue(), SoSFColorRGBA::setValue(), SoSFColorRGBA::setValue(), and SoSFColorRGBA::setValue().
Set a new color. The elements of the array will be read in turned as red, green, blue and transparency.
const float * SbColor4f::getValue | ( | ) | const |
Return pointer to array of 4 float values representing the red, green, blue and transparency values of the color.
void SbColor4f::getValue | ( | float & | r, |
float & | g, | ||
float & | b, | ||
float & | a | ||
) |
Return components of the stored color.
Sets the RGB components of the color. The alpha component is left unchanged.
SbColor4f & SbColor4f::setHSVValue | ( | float | hue, |
float | saturation, | ||
float | value, | ||
float | alpha = 1.0f |
||
) |
Set the color as a hue
, saturation
, value
triplet. The hue component should be normalized to within [0, 1] before you call this method, where 0 is equal to 0° and 1 is equal to 360°.
References SoDebugError::postWarning().
Referenced by setHSVValue(), SoSFColorRGBA::setHSVValue(), and SoSFColorRGBA::setHSVValue().
Set the color as a hue
, saturation
, value
triplet. The hue component should be normalized to within [0, 1] before you call this method, where 0 is equal to 0° and 1 is equal to 360°.
References setHSVValue().
void SbColor4f::getHSVValue | ( | float & | h, |
float & | s, | ||
float & | v | ||
) | const |
Return the color as a hue
, saturation
, value
triplet. Alpha component is ignored.
Referenced by getHSVValue().
void SbColor4f::getHSVValue | ( | float | hsv[3] | ) | const |
Return the color as a hue
, saturation
, value
triplet. Alpha component is ignored.
References getHSVValue().
Set the color value as a 32 bit combined red/green/blue/alpha value. Each component is 8 bit wide (i.e. from 0x00 to 0xff), and the red value should be stored leftmost, like this: 0xRRGGBBAA.
References setValue().
uint32_t SbColor4f::getPackedValue | ( | ) | const |
Return color as a 32 bit packed integer in the form 0xRRGGBBAA.
Referenced by SoVRMLPointSet::GLRender().
float SbColor4f::operator[] | ( | const int | idx | ) | const |
Returns the color component represented by the given index idx. 0 is red, 1 is green, 2 is blue and 3 is the transparency value.
float & SbColor4f::operator[] | ( | const int | idx | ) |
Returns the color component represented by the given index idx. 0 is red, 1 is green, 2 is blue and 3 is the transparency value.
Multiplies the RGB components by d
. The alpha component is left unchanged.
Divides the RGB components by d
. The alpha component is left unchanged.
Subtracts the RGB components. Alpha is ignored.
Multiplies the RGB components by d
. Alpha is left unchanged.
Multiplies the RGB components by d
. Alpha is left unchanged.
Divides the RGB components by d
. Alpha is left unchanged.
Adds the RGB components of the two colors. Alpha is taken from the first color (v1
).
Subtracts the RGB components of the two colors. Alpha is taken from the first color (v1
).
Check if two colors are equal. Returns 1 if equal, 0 if unequal.
Check if two colors are unequal. Returns 0 if equal, 1 if unequal.
Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.
Generated on Wed Jul 19 2023 for Coin by Doxygen. 1.9.8