.TH "SoSFColor" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoSFColor \- 
.PP
The \fBSoSFColor\fP class is a container for an \fBSbColor\fP value\&.
.PP
This field is used where nodes, engines or other field containers needs to store a single color value (i\&.e\&. Red + Green + Blue)\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/fields/SoSFColor\&.h>\fP
.PP
Inherits \fBSoSField\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const "
.br
.ti -1c
.RI "virtual void \fBcopyFrom\fP (const \fBSoField\fP &field)"
.br
.ti -1c
.RI "const \fBSoSFColor\fP & \fBoperator=\fP (const \fBSoSFColor\fP &field)"
.br
.ti -1c
.RI "virtual SbBool \fBisSame\fP (const \fBSoField\fP &field) const "
.br
.ti -1c
.RI "const \fBSbColor\fP & \fBgetValue\fP (void) const "
.br
.ti -1c
.RI "void \fBsetValue\fP (const \fBSbColor\fP &newvalue)"
.br
.ti -1c
.RI "const \fBSbColor\fP & \fBoperator=\fP (const \fBSbColor\fP &newvalue)"
.br
.ti -1c
.RI "int \fBoperator==\fP (const \fBSoSFColor\fP &field) const "
.br
.ti -1c
.RI "int \fBoperator!=\fP (const \fBSoSFColor\fP &field) const "
.br
.ti -1c
.RI "void \fBsetValue\fP (const \fBSbVec3f\fP &vec)"
.br
.ti -1c
.RI "void \fBsetValue\fP (float red, float green, float blue)"
.br
.ti -1c
.RI "void \fBsetValue\fP (const float rgb[3])"
.br
.ti -1c
.RI "void \fBsetHSVValue\fP (float h, float s, float v)"
.br
.ti -1c
.RI "void \fBsetHSVValue\fP (const float hsv[3])"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbColor\fP \fBvalue\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoSFColor\fP class is a container for an \fBSbColor\fP value\&.
.PP
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\&.
.PP
\fBSee also:\fP
.RS 4
\fBSoMFColor\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoSFColor::getTypeId (void) const\fC [virtual]\fP"
Returns the type identification instance which uniquely identifies the Coin field class the object belongs to\&.
.PP
\fBSee also:\fP
.RS 4
getClassTypeId(), \fBSoType\fP 
.RE
.PP

.PP
Implements \fBSoField\fP\&.
.SS "void SoSFColor::copyFrom (const \fBSoField\fP &f)\fC [virtual]\fP"
Copy value(s) from \fIf\fP into this field\&. \fIf\fP must be of the same type as this field\&. 
.PP
Implements \fBSoField\fP\&.
.SS "SbBool SoSFColor::isSame (const \fBSoField\fP &f) const\fC [virtual]\fP"
Check for equal type and value(s)\&. 
.PP
Implements \fBSoField\fP\&.
.SS "void SoSFColor::setValue (const \fBSbVec3f\fP &vec)"
Set color value from a vector with three elements\&. The three elements will be interpreted as red, green and blue, respectively\&. 
.SS "void SoSFColor::setValue (floatred, floatgreen, floatblue)"
Set color value from \fIred\fP, \fIgreen\fP and \fIblue\fP\&. Value range for each component is between 0\&.0 and 1\&.0\&. 
.SS "void SoSFColor::setValue (const floatrgb[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\&. 
.SS "void SoSFColor::setHSVValue (floath, floats, floatv)"
Set color value from \fIh\fP, \fIs\fP and \fIv\fP, where \fIis\fP 'hue', \fIs\fP is 'saturation' and \fIv\fP is 'value'\&. 
.SS "void SoSFColor::setHSVValue (const floathsv[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\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.