Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 : #ifndef INCLUDED_TOOLS_COLOR_HXX
20 : #define INCLUDED_TOOLS_COLOR_HXX
21 :
22 : #include <tools/toolsdllapi.h>
23 :
24 : class SvStream;
25 : class ResId;
26 :
27 : #include <basegfx/color/bcolor.hxx>
28 :
29 : // Color types
30 : typedef sal_uInt32 ColorData;
31 : #define RGB_COLORDATA( r,g,b ) ((ColorData)(((sal_uInt32)((sal_uInt8)(b))))|(((sal_uInt32)((sal_uInt8)(g)))<<8)|(((sal_uInt32)((sal_uInt8)(r)))<<16))
32 : #define TRGB_COLORDATA( t,r,g,b ) ((ColorData)(((sal_uInt32)((sal_uInt8)(b))))|(((sal_uInt32)((sal_uInt8)(g)))<<8)|(((sal_uInt32)((sal_uInt8)(r)))<<16)|(((sal_uInt32)((sal_uInt8)(t)))<<24))
33 : #define COLORDATA_RED( n ) ((sal_uInt8)((n)>>16))
34 : #define COLORDATA_GREEN( n ) ((sal_uInt8)(((sal_uInt16)(n)) >> 8))
35 : #define COLORDATA_BLUE( n ) ((sal_uInt8)(n))
36 : #define COLORDATA_TRANSPARENCY( n ) ((sal_uInt8)((n)>>24))
37 : #define COLORDATA_RGB( n ) ((ColorData)((n) & 0x00FFFFFF))
38 :
39 : #define COL_BLACK RGB_COLORDATA( 0x00, 0x00, 0x00 )
40 : #define COL_BLUE RGB_COLORDATA( 0x00, 0x00, 0x80 )
41 : #define COL_GREEN RGB_COLORDATA( 0x00, 0x80, 0x00 )
42 : #define COL_CYAN RGB_COLORDATA( 0x00, 0x80, 0x80 )
43 : #define COL_RED RGB_COLORDATA( 0x80, 0x00, 0x00 )
44 : #define COL_MAGENTA RGB_COLORDATA( 0x80, 0x00, 0x80 )
45 : #define COL_BROWN RGB_COLORDATA( 0x80, 0x80, 0x00 )
46 : #define COL_GRAY RGB_COLORDATA( 0x80, 0x80, 0x80 )
47 : #define COL_LIGHTGRAY RGB_COLORDATA( 0xC0, 0xC0, 0xC0 )
48 : #define COL_LIGHTBLUE RGB_COLORDATA( 0x00, 0x00, 0xFF )
49 : #define COL_LIGHTGREEN RGB_COLORDATA( 0x00, 0xFF, 0x00 )
50 : #define COL_LIGHTCYAN RGB_COLORDATA( 0x00, 0xFF, 0xFF )
51 : #define COL_LIGHTRED RGB_COLORDATA( 0xFF, 0x00, 0x00 )
52 : #define COL_LIGHTMAGENTA RGB_COLORDATA( 0xFF, 0x00, 0xFF )
53 : #define COL_LIGHTGRAYBLUE RGB_COLORDATA( 0xE0, 0xE0, 0xFF )
54 : #define COL_YELLOW RGB_COLORDATA( 0xFF, 0xFF, 0x00 )
55 : #define COL_WHITE RGB_COLORDATA( 0xFF, 0xFF, 0xFF )
56 : #define COL_TRANSPARENT TRGB_COLORDATA( 0xFF, 0xFF, 0xFF, 0xFF )
57 : #define COL_AUTO (ColorData)0xFFFFFFFF
58 : #define COL_AUTHOR1_DARK RGB_COLORDATA(198, 146, 0)
59 : #define COL_AUTHOR1_NORMAL RGB_COLORDATA(255, 255, 158)
60 : #define COL_AUTHOR1_LIGHT RGB_COLORDATA(255, 255, 195)
61 : #define COL_AUTHOR2_DARK RGB_COLORDATA(6, 70, 162)
62 : #define COL_AUTHOR2_NORMAL RGB_COLORDATA(216, 232, 255)
63 : #define COL_AUTHOR2_LIGHT RGB_COLORDATA(233, 242, 255)
64 : #define COL_AUTHOR3_DARK RGB_COLORDATA(87, 157, 28)
65 : #define COL_AUTHOR3_NORMAL RGB_COLORDATA(218, 248, 193)
66 : #define COL_AUTHOR3_LIGHT RGB_COLORDATA(226, 250, 207)
67 : #define COL_AUTHOR4_DARK RGB_COLORDATA(105, 43, 157)
68 : #define COL_AUTHOR4_NORMAL RGB_COLORDATA(228, 210, 245)
69 : #define COL_AUTHOR4_LIGHT RGB_COLORDATA(239, 228, 248)
70 : #define COL_AUTHOR5_DARK RGB_COLORDATA(197, 0, 11)
71 : #define COL_AUTHOR5_NORMAL RGB_COLORDATA(254, 205, 208)
72 : #define COL_AUTHOR5_LIGHT RGB_COLORDATA(255, 227, 229)
73 : #define COL_AUTHOR6_DARK RGB_COLORDATA(0, 128, 128)
74 : #define COL_AUTHOR6_NORMAL RGB_COLORDATA(210, 246, 246)
75 : #define COL_AUTHOR6_LIGHT RGB_COLORDATA(230, 250, 250)
76 : #define COL_AUTHOR7_DARK RGB_COLORDATA(140, 132, 0)
77 : #define COL_AUTHOR7_NORMAL RGB_COLORDATA(237, 252, 163)
78 : #define COL_AUTHOR7_LIGHT RGB_COLORDATA(242, 254, 181)
79 : #define COL_AUTHOR8_DARK RGB_COLORDATA(53, 85, 107)
80 : #define COL_AUTHOR8_NORMAL RGB_COLORDATA(211, 222, 232)
81 : #define COL_AUTHOR8_LIGHT RGB_COLORDATA(226, 234, 241)
82 : #define COL_AUTHOR9_DARK RGB_COLORDATA(209, 118, 0)
83 : #define COL_AUTHOR9_NORMAL RGB_COLORDATA(255, 226, 185)
84 : #define COL_AUTHOR9_LIGHT RGB_COLORDATA(255, 231, 199)
85 :
86 : #define COLOR_CHANNEL_MERGE( _def_cDst, _def_cSrc, _def_cSrcTrans ) \
87 : ((sal_uInt8)((((long)(_def_cDst)-(_def_cSrc))*(_def_cSrcTrans)+(((_def_cSrc)<<8L)|(_def_cDst)))>>8L))
88 :
89 : // Color
90 :
91 : class TOOLS_DLLPUBLIC SAL_WARN_UNUSED Color
92 : {
93 : protected:
94 : ColorData mnColor;
95 :
96 : public:
97 412419335 : Color() { mnColor = COL_BLACK; }
98 15918257 : Color( ColorData nColor ) { mnColor = nColor; }
99 4123359 : Color( sal_uInt8 nRed, sal_uInt8 nGreen, sal_uInt8 nBlue )
100 4123359 : { mnColor = RGB_COLORDATA( nRed, nGreen, nBlue ); }
101 5878 : Color( sal_uInt8 nTransparency, sal_uInt8 nRed, sal_uInt8 nGreen, sal_uInt8 nBlue )
102 5878 : { mnColor = TRGB_COLORDATA( nTransparency, nRed, nGreen, nBlue ); }
103 : // This ctor is defined in svtools, not tools!
104 : Color( const ResId& rResId );
105 :
106 : // constructor to create a tools-Color from ::basegfx::BColor
107 424428 : explicit Color(const ::basegfx::BColor& rBColor)
108 : {
109 424428 : mnColor = RGB_COLORDATA(
110 : sal_uInt8((rBColor.getRed() * 255.0) + 0.5),
111 : sal_uInt8((rBColor.getGreen() * 255.0) + 0.5),
112 424428 : sal_uInt8((rBColor.getBlue() * 255.0) + 0.5));
113 424428 : }
114 :
115 : void SetRed( sal_uInt8 nRed );
116 8440543 : sal_uInt8 GetRed() const { return COLORDATA_RED( mnColor ); }
117 : void SetGreen( sal_uInt8 nGreen );
118 8438898 : sal_uInt8 GetGreen() const { return COLORDATA_GREEN( mnColor ); }
119 : void SetBlue( sal_uInt8 nBlue );
120 8438856 : sal_uInt8 GetBlue() const { return COLORDATA_BLUE( mnColor ); }
121 : void SetTransparency( sal_uInt8 nTransparency );
122 7746115 : sal_uInt8 GetTransparency() const { return COLORDATA_TRANSPARENCY( mnColor ); }
123 :
124 103945 : void SetColor( ColorData nColor ) { mnColor = nColor; }
125 673707 : ColorData GetColor() const { return mnColor; }
126 11388 : ColorData GetRGBColor() const { return COLORDATA_RGB( mnColor ); }
127 :
128 : sal_uInt8 GetColorError( const Color& rCompareColor ) const;
129 :
130 : sal_uInt8 GetLuminance() const;
131 : void IncreaseLuminance( sal_uInt8 cLumInc );
132 : void DecreaseLuminance( sal_uInt8 cLumDec );
133 :
134 : void DecreaseContrast( sal_uInt8 cContDec );
135 :
136 : void Invert();
137 :
138 : void Merge( const Color& rMergeColor, sal_uInt8 cTransparency );
139 :
140 : bool IsRGBEqual( const Color& rColor ) const;
141 :
142 : // comparison with luminance thresholds
143 : bool IsDark() const;
144 : bool IsBright() const;
145 :
146 : // color space conversion tools
147 : // the range for h/s/b is:
148 : // Hue: 0-360 degree
149 : // Saturation: 0-100%
150 : // Brightness: 0-100%
151 : static ColorData HSBtoRGB( sal_uInt16 nHue, sal_uInt16 nSat, sal_uInt16 nBri );
152 : void RGBtoHSB( sal_uInt16& nHue, sal_uInt16& nSat, sal_uInt16& nBri ) const;
153 :
154 31142324 : bool operator==( const Color& rColor ) const
155 31142324 : { return (mnColor == rColor.mnColor); }
156 22554580 : bool operator!=( const Color& rColor ) const
157 22554580 : { return !(Color::operator==( rColor )); }
158 :
159 : SvStream& Read( SvStream& rIStm, bool bNewFormat = true );
160 : SvStream& Write( SvStream& rOStm, bool bNewFormat = true );
161 :
162 : TOOLS_DLLPUBLIC friend SvStream& ReadColor( SvStream& rIStream, Color& rColor );
163 : TOOLS_DLLPUBLIC friend SvStream& WriteColor( SvStream& rOStream, const Color& rColor );
164 :
165 : // Return color as RGB hex string
166 : // for example "00ff00" for green color
167 : OUString AsRGBHexString();
168 :
169 : // get ::basegfx::BColor from this color
170 198787 : ::basegfx::BColor getBColor() const { return ::basegfx::BColor(GetRed() / 255.0, GetGreen() / 255.0, GetBlue() / 255.0); }
171 : };
172 :
173 83574 : inline void Color::SetRed( sal_uInt8 nRed )
174 : {
175 83574 : mnColor &= 0xFF00FFFF;
176 83574 : mnColor |= ((sal_uInt32)nRed)<<16;
177 83574 : }
178 :
179 83574 : inline void Color::SetGreen( sal_uInt8 nGreen )
180 : {
181 83574 : mnColor &= 0xFFFF00FF;
182 83574 : mnColor |= ((sal_uInt16)nGreen)<<8;
183 83574 : }
184 :
185 83574 : inline void Color::SetBlue( sal_uInt8 nBlue )
186 : {
187 83574 : mnColor &= 0xFFFFFF00;
188 83574 : mnColor |= nBlue;
189 83574 : }
190 :
191 72027 : inline void Color::SetTransparency( sal_uInt8 nTransparency )
192 : {
193 72027 : mnColor &= 0x00FFFFFF;
194 72027 : mnColor |= ((sal_uInt32)nTransparency)<<24;
195 72027 : }
196 :
197 398 : inline bool Color::IsRGBEqual( const Color& rColor ) const
198 : {
199 398 : return (COLORDATA_RGB( mnColor ) == COLORDATA_RGB( rColor.mnColor ));
200 : }
201 :
202 501634 : inline sal_uInt8 Color::GetLuminance() const
203 : {
204 1003268 : return( (sal_uInt8) ( ( COLORDATA_BLUE( mnColor ) * 29UL +
205 1003268 : COLORDATA_GREEN( mnColor ) * 151UL +
206 1003268 : COLORDATA_RED( mnColor ) * 76UL ) >> 8UL ) );
207 : }
208 :
209 51022 : inline void Color::Merge( const Color& rMergeColor, sal_uInt8 cTransparency )
210 : {
211 51022 : SetRed( COLOR_CHANNEL_MERGE( COLORDATA_RED( mnColor ), COLORDATA_RED( rMergeColor.mnColor ), cTransparency ) );
212 51022 : SetGreen( COLOR_CHANNEL_MERGE( COLORDATA_GREEN( mnColor ), COLORDATA_GREEN( rMergeColor.mnColor ), cTransparency ) );
213 51022 : SetBlue( COLOR_CHANNEL_MERGE( COLORDATA_BLUE( mnColor ), COLORDATA_BLUE( rMergeColor.mnColor ), cTransparency ) );
214 51022 : }
215 :
216 : #endif
217 :
218 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
