Open Inventor Reference
SbColor.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.2 $
45  |
46  | Description:
47  | This file contains the SbColor class definition.
48  |
49  | Author(s) : Alain Dumesny
50  |
51  ______________ S I L I C O N G R A P H I C S I N C . ____________
52  _______________________________________________________________________
53  */
54 
55 #ifndef _SB_COLOR_H_
56 #define _SB_COLOR_H_
57 
59 #include <Inventor/SbLinear.h>
60 
61 
62 
63 class SbColor;
64 
65 
66 
67 
70 
83 
84 class INVENTOR_API SbColor : public SbVec3f {
85  public:
88 
90  SbColor(const SbVec3f vec3f) { setValue(vec3f.getValue()); }
91 
93  SbColor(const float rgb[3]) { setValue(rgb); }
94 
96  SbColor(float r, float g, float b) { setValue(r, g, b); }
97 
100  SbColor & setHSVValue(float h, float s, float v);
101 
103  SbColor & setHSVValue(const float hsv[3])
104  { return setHSVValue(hsv[0], hsv[1], hsv[2]); }
105 
107  void getHSVValue(float &h, float &s, float &v) const;
108 
110  void getHSVValue(float hsv[3]) const
111  { getHSVValue(hsv[0], hsv[1], hsv[2]); }
112 
126  SbColor & setPackedValue(uint32_t orderedRGBA, float& transparency);
127 
133  uint32_t getPackedValue(float transparency = 0.0) const;
134 
138 
139 
140 
141 
142 
143 
144 
145 
146 
147 };
148 
149 #endif /* _SB_COLOR_H_ */
150 
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
unsigned int uint32_t
Definition: SbTypeDefs.h:44
Color vector class.
Definition: SbColor.h:84
void getHSVValue(float &h, float &s, float &v) const
Returns 3 individual hsv components.
SbColor & setHSVValue(const float hsv[3])
Sets value of color vector from array of 3 HSV components.
Definition: SbColor.h:103
void getHSVValue(float hsv[3]) const
Returns an array of 3 hsv components.
Definition: SbColor.h:110
uint32_t getPackedValue(float transparency=0.0) const
Returns an RGBA packed color value, derived from the color vector and the passed transparency value.
SbColor()
Default constructor.
SbColor(float r, float g, float b)
Constructors for color vector.
Definition: SbColor.h:96
SbColor & setPackedValue(uint32_t orderedRGBA, float &transparency)
Sets value of color vector from an RGBA packed color value.
SbColor(const SbVec3f vec3f)
Constructors for color vector.
Definition: SbColor.h:90
SbColor(const float rgb[3])
Constructors for color vector.
Definition: SbColor.h:93
SbColor & setHSVValue(float h, float s, float v)
Sets value of color vector from 3 HSV (Hue, Saturation, and Value) components.
3D vector class.
Definition: SbLinear.h:120
SbVec3f & setValue(const float v[3])
Sets the vector components.
Definition: SbLinear.h:159
const float * getValue() const
Returns vector components.
Definition: SbLinear.h:144