0030991: Draw Harness - ViewerTest::ParseColor() defines out-of-range alpha component
[occt.git] / src / Quantity / Quantity_ColorRGBA.hxx
CommitLineData
b6472664 1// Copyright (c) 2016 OPEN CASCADE SAS
2//
3// This file is part of Open CASCADE Technology software library.
4//
5// This library is free software; you can redistribute it and/or modify it under
6// the terms of the GNU Lesser General Public License version 2.1 as published
7// by the Free Software Foundation, with special exception defined in the file
8// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9// distribution for complete text of the license and disclaimer of any warranty.
10//
11// Alternatively, this file may be used under the terms of Open CASCADE
12// commercial license or contractual agreement.
13
14#ifndef _Quantity_ColorRGBA_HeaderFile
15#define _Quantity_ColorRGBA_HeaderFile
16
17#include <Quantity_Color.hxx>
18#include <Standard_Assert.hxx>
19
20//! The pair of Quantity_Color and Alpha component (1.0 opaque, 0.0 transparent).
21class Quantity_ColorRGBA
22{
23public:
24
25 //! Creates a color with the default value.
26 Quantity_ColorRGBA() : myAlpha (1.0f) {}
27
28 //! Creates the color with specified RGB value.
e958a649 29 explicit Quantity_ColorRGBA (const Quantity_Color& theRgb)
30 : myRgb (theRgb), myAlpha (1.0f)
31 {}
32
33 //! Creates the color with specified RGBA values.
34 Quantity_ColorRGBA (const Quantity_Color& theRgb, float theAlpha)
35 : myRgb (theRgb), myAlpha (theAlpha)
36 {}
b6472664 37
38 //! Creates the color from RGBA vector.
e958a649 39 explicit Quantity_ColorRGBA (const NCollection_Vec4<float>& theRgba)
40 : myRgb (theRgba.rgb()), myAlpha (theRgba.a())
41 {}
42
43 //! Creates the color from RGBA values.
44 Quantity_ColorRGBA (float theRed, float theGreen, float theBlue, float theAlpha)
45 : myRgb (theRed, theGreen, theBlue, Quantity_TOC_RGB),
46 myAlpha (theAlpha)
47 {}
48
49 //! Assign new values to the color.
50 void SetValues (float theRed, float theGreen, float theBlue, float theAlpha)
51 {
52 myRgb.SetValues (theRed, theGreen, theBlue, Quantity_TOC_RGB);
53 myAlpha = theAlpha;
54 }
b6472664 55
56 //! Return RGB color value.
57 const Quantity_Color& GetRGB() const { return myRgb; }
58
59 //! Modify RGB color components without affecting alpha value.
60 Quantity_Color& ChangeRGB() { return myRgb; }
61
62 //! Assign RGB color components without affecting alpha value.
63 void SetRGB (const Quantity_Color& theRgb) { myRgb = theRgb; }
64
65 //! Return alpha value (1.0 means opaque, 0.0 means fully transparent).
66 Standard_ShortReal Alpha() const { return myAlpha; }
67
68 //! Assign the alpha value.
69 void SetAlpha (const Standard_ShortReal theAlpha) { myAlpha = theAlpha; }
70
71 //! Return the color as vector of 4 float elements.
72 operator const NCollection_Vec4<float>&() const { return *(const NCollection_Vec4<float>* )this; }
73
74 //! Returns true if the distance between colors is greater than Epsilon().
75 bool IsDifferent (const Quantity_ColorRGBA& theOther) const
76 {
77 return myRgb.IsDifferent (theOther.GetRGB())
78 || Abs(myAlpha - theOther.myAlpha) > (float )Quantity_Color::Epsilon();
79 }
80
81 //! Returns true if the distance between colors is greater than Epsilon().
82 bool operator!= (const Quantity_ColorRGBA& theOther) const { return IsDifferent (theOther); }
83
84 //! Two colors are considered to be equal if their distance is no greater than Epsilon().
85 bool IsEqual (const Quantity_ColorRGBA& theOther) const
86 {
87 return myRgb.IsEqual (theOther.GetRGB())
88 && Abs(myAlpha - theOther.myAlpha) <= (float )Quantity_Color::Epsilon();
89 }
90
91 //! Two colors are considered to be equal if their distance is no greater than Epsilon().
92 bool operator== (const Quantity_ColorRGBA& theOther) const { return IsEqual (theOther); }
93
f9b30c0d 94 //! Finds color from predefined names.
95 //! For example, the name of the color which
96 //! corresponds to "BLACK" is Quantity_NOC_BLACK.
97 //! Returns false if name is unknown.
98 //! An alpha component is set to 1.0.
99 //! @param theColorNameString the color name
100 //! @param theColor a found color
101 //! @return false if the color name is unknown, or true if the search by color name was successful
102 static Standard_Boolean ColorFromName (const Standard_CString theColorNameString, Quantity_ColorRGBA& theColor)
103 {
104 Quantity_ColorRGBA aColor;
105 if (!Quantity_Color::ColorFromName (theColorNameString, aColor.ChangeRGB()))
106 {
107 return false;
108 }
109 theColor = aColor;
110 return true;
111 }
112
113 //! Parses the string as a hex color (like "#FF0" for short RGB color, "#FF0F" for short RGBA color,
114 //! "#FFFF00" for RGB color, or "#FFFF00FF" for RGBA color)
115 //! @param theHexColorString the string to be parsed
116 //! @param theColor a color that is a result of parsing
117 //! @param theAlphaComponentIsOff the flag that indicates if a color alpha component is presented
118 //! in the input string (false) or not (true)
119 //! @return true if parsing was successful, or false otherwise
120 Standard_EXPORT static bool ColorFromHex (const char* const theHexColorString,
121 Quantity_ColorRGBA& theColor,
122 const bool theAlphaComponentIsOff = false);
123
9196ea9d 124 //! Returns hex sRGBA string in format "#RRGGBBAA".
125 static TCollection_AsciiString ColorToHex (const Quantity_ColorRGBA& theColor,
126 const bool theToPrefixHash = true)
127 {
128 NCollection_Vec4<Standard_ShortReal> anSRgb = (NCollection_Vec4<Standard_ShortReal> )theColor;
129 NCollection_Vec4<Standard_Integer> anSRgbInt (anSRgb * 255.0f + NCollection_Vec4<Standard_ShortReal> (0.5f));
130 char aBuff[12];
131 Sprintf (aBuff, theToPrefixHash ? "#%02X%02X%02X%02X" : "%02X%02X%02X%02X",
132 anSRgbInt.r(), anSRgbInt.g(), anSRgbInt.b(), anSRgbInt.a());
133 return aBuff;
134 }
135
0904aa63 136 //! Dumps the content of me into the stream
137 Standard_EXPORT void DumpJson (Standard_OStream& theOStream, const Standard_Integer theDepth = -1) const;
138
b6472664 139private:
140
e958a649 141 static void myTestSize3() { Standard_STATIC_ASSERT (sizeof(float) * 3 == sizeof(Quantity_Color)); }
142 static void myTestSize4() { Standard_STATIC_ASSERT (sizeof(float) * 4 == sizeof(Quantity_ColorRGBA)); }
b6472664 143
144private:
145
146 Quantity_Color myRgb;
147 Standard_ShortReal myAlpha;
148
149};
150
151#endif // _Quantity_ColorRGBA_HeaderFile