Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TColor.h
Go to the documentation of this file.
1// @(#)root/base:$Id$
2// Author: Rene Brun 12/12/94
3
4/*************************************************************************
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TColor
13#define ROOT_TColor
14
15#include "TNamed.h"
16
17#include <vector>
18
19class TArrayI;
20
21class TColor : public TNamed {
22protected:
23 Int_t fNumber; ///< Color number identifier
24private:
25 Float_t fRed; ///< Fraction of Red
26 Float_t fGreen; ///< Fraction of Green
27 Float_t fBlue; ///< Fraction of Blue
28 Float_t fHue; ///< Hue
29 Float_t fLight; ///< Light
30 Float_t fSaturation; ///< Saturation
31 Float_t fAlpha; ///< Alpha (transparency)
32
33 void Allocate();
34 static Float_t HLStoRGB1(Float_t rn1, Float_t rn2, Float_t huei);
35
36public:
37 TColor();
38 TColor(Int_t color, Float_t r, Float_t g, Float_t b, const char *name="", Float_t a = 1);
40 TColor(const TColor &color);
41 TColor &operator=(const TColor &color);
42 virtual ~TColor();
43 const char *AsHexString() const;
44 void Copy(TObject &color) const override;
45 static void CreateColorWheel();
46 static void CreateColorsGray();
47 static void CreateColorsCircle(Int_t offset, const char *name, UChar_t *rgb);
48 static void CreateColorsRectangle(Int_t offset, const char *name, UChar_t *rgb);
49 static Int_t CreateColorTableFromFile(TString fileName, Float_t alpha=1.);
50 static Int_t CreateGradientColorTable(UInt_t Number, Double_t* Stops,
51 Double_t* Red, Double_t* Green, Double_t* Blue, UInt_t NColors, Float_t alpha=1., Bool_t setPalette=kTRUE);
52 static Int_t GetColorPalette(Int_t i);
53 static Int_t GetNumberOfColors();
54 virtual void GetRGB(Float_t &r, Float_t &g, Float_t &b) const
55 { r=GetRed(); g=GetGreen(); b=GetBlue(); }
56 virtual void GetHLS(Float_t &h, Float_t &l, Float_t &s) const
57 { h=GetHue(); l=GetLight(); s=GetSaturation(); }
58 Int_t GetNumber() const { return fNumber; }
59 ULong_t GetPixel() const;
60 Float_t GetRed() const { return IsGrayscale() ? GetGrayscale() : fRed; }
61 Float_t GetGreen() const { return IsGrayscale() ? GetGrayscale() : fGreen; }
62 Float_t GetBlue() const { return IsGrayscale() ? GetGrayscale() : fBlue; }
63 Float_t GetHue() const { return fHue; }
64 Float_t GetLight() const { return fLight; }
65 Float_t GetSaturation() const { return IsGrayscale() ? 0 : fSaturation; }
66 Float_t GetAlpha() const { return fAlpha; }
67 virtual Float_t GetGrayscale() const { /*ITU*/ return 0.299f*fRed + 0.587f*fGreen + 0.114f*fBlue; }
68 void ls(Option_t *option="") const override;
69 void Print(Option_t *option="") const override;
70 virtual void SetAlpha(Float_t a) { fAlpha = a; }
71 virtual void SetRGB(Float_t r, Float_t g, Float_t b);
72
73 static void InitializeColors();
74 static void HLS2RGB(Float_t h, Float_t l, Float_t s, Float_t &r, Float_t &g, Float_t &b);
75 static void HLS2RGB(Int_t h, Int_t l, Int_t s, Int_t &r, Int_t &g, Int_t &b);
77 { TColor::HLS2RGB(h, l, s, r, g, b); } // backward compatible
78 static void HSV2RGB(Float_t h, Float_t s, Float_t v, Float_t &r, Float_t &g, Float_t &b);
79 static void RGB2HLS(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s);
80 static void RGB2HLS(Int_t r, Int_t g, Int_t b, Int_t &h, Int_t &l, Int_t &s);
82 { TColor::RGB2HLS(r, g, b, h, l, s); } // backward compatible
83 static void RGB2HSV(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &s, Float_t &v);
84 static Int_t GetColor(const char *hexcolor);
85 static Int_t GetColor(Float_t r, Float_t g, Float_t b, Float_t a = 1.);
86 static Int_t GetColor(Int_t r, Int_t g, Int_t b, Float_t a = 1.);
88 static Int_t GetColorBright(Int_t color);
89 static Int_t GetColorDark(Int_t color);
91 static Int_t GetFreeColorIndex();
92 static const TArrayI& GetPalette();
93 static Int_t GetLinearGradient(Double_t angle, const std::vector<Int_t> &colors, const std::vector<Double_t> &positions = {});
94 static Int_t GetRadialGradient(Double_t r, const std::vector<Int_t> &colors, const std::vector<Double_t> &positions = {});
95 static ULong_t Number2Pixel(Int_t ci);
98 static void Pixel2RGB(ULong_t pixel, Int_t &r, Int_t &g, Int_t &b);
99 static void Pixel2RGB(ULong_t pixel, Float_t &r, Float_t &g, Float_t &b);
100 static const char *PixelAsHexString(ULong_t pixel);
101 static Bool_t SaveColor(std::ostream &out, Int_t ci);
102 static void SetColorThreshold(Float_t t);
103 static Bool_t DefinedColors(Int_t set_always_on = 0);
104 static void InvertPalette();
105 static Bool_t IsGrayscale();
106 static void SetGrayscale(Bool_t set = kTRUE);
107 static void SetPalette(Int_t ncolors, Int_t *colors, Float_t alpha=1.);
108
109 ClassDefOverride(TColor,2) //Color defined by RGB or HLS
110};
111
125 kNeon=90, kPastel=91, kPearl=92,
131 kWaterMelon=108, kCool=109, kCopper=110,
134#endif
135
#define b(i)
Definition RSha256.hxx:100
#define g(i)
Definition RSha256.hxx:105
#define a(i)
Definition RSha256.hxx:99
#define h(i)
Definition RSha256.hxx:106
bool Bool_t
Definition RtypesCore.h:63
int Int_t
Definition RtypesCore.h:45
unsigned char UChar_t
Definition RtypesCore.h:38
unsigned long ULong_t
Definition RtypesCore.h:55
float Float_t
Definition RtypesCore.h:57
double Double_t
Definition RtypesCore.h:59
constexpr Bool_t kTRUE
Definition RtypesCore.h:100
const char Option_t
Definition RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition Rtypes.h:341
EColorPalette
Definition TColor.h:112
@ kFall
Definition TColor.h:121
@ kStarryNight
Definition TColor.h:129
@ kAtlantic
Definition TColor.h:117
@ kIsland
Definition TColor.h:123
@ kBlackBody
Definition TColor.h:118
@ kFruitPunch
Definition TColor.h:121
@ kArmy
Definition TColor.h:116
@ kAurora
Definition TColor.h:117
@ kBrownCyan
Definition TColor.h:119
@ kBeach
Definition TColor.h:118
@ kAquamarine
Definition TColor.h:116
@ kPastel
Definition TColor.h:125
@ kCubehelix
Definition TColor.h:114
@ kAvocado
Definition TColor.h:117
@ kGreenRedViolet
Definition TColor.h:114
@ kAlpine
Definition TColor.h:116
@ kVisibleSpectrum
Definition TColor.h:130
@ kCMYK
Definition TColor.h:119
@ kInvertedDarkBodyRadiator
Definition TColor.h:113
@ kWaterMelon
Definition TColor.h:131
@ kOcean
Definition TColor.h:115
@ kDarkBodyRadiator
Definition TColor.h:112
@ kDarkTerrain
Definition TColor.h:121
@ kLightTemperature
Definition TColor.h:124
@ kRust
Definition TColor.h:127
@ kCopper
Definition TColor.h:131
@ kTemperatureMap
Definition TColor.h:129
@ kSolar
Definition TColor.h:128
@ kRedBlue
Definition TColor.h:126
@ kDeepSea
Definition TColor.h:112
@ kRainBow
Definition TColor.h:113
@ kSouthWest
Definition TColor.h:128
@ kPlum
Definition TColor.h:126
@ kGreenBrownTerrain
Definition TColor.h:122
@ kGreyYellow
Definition TColor.h:122
@ kGreyScale
Definition TColor.h:112
@ kRose
Definition TColor.h:127
@ kRainbow
Definition TColor.h:133
@ kSunset
Definition TColor.h:129
@ kCoffee
Definition TColor.h:120
@ kGreenPink
Definition TColor.h:123
@ kColorPrintableOnGrey
Definition TColor.h:115
@ kSienna
Definition TColor.h:128
@ kBlueYellow
Definition TColor.h:113
@ kBlueRedYellow
Definition TColor.h:115
@ kValentine
Definition TColor.h:130
@ kDarkRainbow
Definition TColor.h:133
@ kSandyTerrain
Definition TColor.h:127
@ kDarkRainBow
Definition TColor.h:120
@ kViridis
Definition TColor.h:132
@ kCandy
Definition TColor.h:119
@ kCherry
Definition TColor.h:120
@ kNeon
Definition TColor.h:125
@ kBird
Definition TColor.h:114
@ kFuchsia
Definition TColor.h:122
@ kBlueGreenYellow
Definition TColor.h:118
@ kPearl
Definition TColor.h:125
@ kPigeon
Definition TColor.h:126
@ kCividis
Definition TColor.h:132
@ kCool
Definition TColor.h:131
@ kLake
Definition TColor.h:123
@ kMint
Definition TColor.h:124
@ kGistEarth
Definition TColor.h:132
@ kThermometer
Definition TColor.h:130
@ kLightTerrain
Definition TColor.h:124
Option_t Option_t option
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void pixel
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h offset
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t r
Option_t Option_t TPoint TPoint angle
char name[80]
Definition TGX11.cxx:110
Color * colors
Definition X3DBuffer.c:21
Array of integers (32 bits per element).
Definition TArrayI.h:27
The color creation and management class.
Definition TColor.h:21
void Print(Option_t *option="") const override
Dump this color with its attributes.
Definition TColor.cxx:1658
Float_t fSaturation
Saturation.
Definition TColor.h:30
static void SetPalette(Int_t ncolors, Int_t *colors, Float_t alpha=1.)
Static function.
Definition TColor.cxx:2740
static Int_t GetLinearGradient(Double_t angle, const std::vector< Int_t > &colors, const std::vector< Double_t > &positions={})
Static function: Returns the linear gradient color number corresponding to specified parameters.
Definition TColor.cxx:2092
static void HLS2RGB(Float_t h, Float_t l, Float_t s, Float_t &r, Float_t &g, Float_t &b)
Static method to compute RGB from HLS.
Definition TColor.cxx:1527
virtual void SetRGB(Float_t r, Float_t g, Float_t b)
Initialize this color and its associated colors.
Definition TColor.cxx:1775
static void RGBtoHLS(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s)
Definition TColor.h:81
static Float_t HLStoRGB1(Float_t rn1, Float_t rn2, Float_t huei)
Static method. Auxiliary to HLS2RGB().
Definition TColor.cxx:1552
virtual void GetRGB(Float_t &r, Float_t &g, Float_t &b) const
Definition TColor.h:54
static Int_t GetRadialGradient(Double_t r, const std::vector< Int_t > &colors, const std::vector< Double_t > &positions={})
Static function: Returns the radial gradient color number corresponding to specified parameters.
Definition TColor.cxx:2169
static Int_t GetColorPalette(Int_t i)
Static function returning the color number i in current palette.
Definition TColor.cxx:1455
static const TArrayI & GetPalette()
Static function returning the current active palette.
Definition TColor.cxx:1467
Float_t GetRed() const
Definition TColor.h:60
void ls(Option_t *option="") const override
List this color with its attributes.
Definition TColor.cxx:1649
static Bool_t SaveColor(std::ostream &out, Int_t ci)
Save a color with index > 228 as a C++ statement(s) on output stream out.
Definition TColor.cxx:2362
Float_t fLight
Light.
Definition TColor.h:29
static ULong_t RGB2Pixel(Int_t r, Int_t g, Int_t b)
Convert r,g,b to graphics system dependent pixel value.
Definition TColor.cxx:2294
static ULong_t Number2Pixel(Int_t ci)
Static method that given a color index number, returns the corresponding pixel value.
Definition TColor.cxx:2256
static void RGB2HSV(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &s, Float_t &v)
Static method to compute HSV from RGB.
Definition TColor.cxx:1722
static Int_t GetColor(const char *hexcolor)
Static method returning color number for color specified by hex color string of form: "#rrggbb",...
Definition TColor.cxx:1839
static void InitializeColors()
Initialize colors used by the TCanvas based graphics (via TColor objects).
Definition TColor.cxx:1148
static void HSV2RGB(Float_t h, Float_t s, Float_t v, Float_t &r, Float_t &g, Float_t &b)
Static method to compute RGB from HSV:
Definition TColor.cxx:1593
Float_t fAlpha
Alpha (transparency)
Definition TColor.h:31
void Copy(TObject &color) const override
Copy this color to obj.
Definition TColor.cxx:1295
static void InvertPalette()
Invert the current color palette.
Definition TColor.cxx:3459
Float_t fHue
Hue.
Definition TColor.h:28
static void CreateColorWheel()
Static function steering the creation of all colors in the color wheel.
Definition TColor.cxx:1367
virtual void GetHLS(Float_t &h, Float_t &l, Float_t &s) const
Definition TColor.h:56
static Int_t GetColorBright(Int_t color)
Static function: Returns the bright color number corresponding to n If the TColor object does not exi...
Definition TColor.cxx:1992
static Bool_t IsGrayscale()
Return whether all colors return grayscale values.
Definition TColor.cxx:2403
static void Pixel2RGB(ULong_t pixel, Int_t &r, Int_t &g, Int_t &b)
Convert machine dependent pixel value (obtained via RGB2Pixel or via Number2Pixel() or via TColor::Ge...
Definition TColor.cxx:2332
const char * AsHexString() const
Return color as hexadecimal string.
Definition TColor.cxx:1274
static Int_t GetColorDark(Int_t color)
Static function: Returns the dark color number corresponding to n If the TColor object does not exist...
Definition TColor.cxx:2024
Float_t GetAlpha() const
Definition TColor.h:66
static Int_t CreateGradientColorTable(UInt_t Number, Double_t *Stops, Double_t *Red, Double_t *Green, Double_t *Blue, UInt_t NColors, Float_t alpha=1., Bool_t setPalette=kTRUE)
Static function creating a color table with several connected linear gradients.
Definition TColor.cxx:2549
static const char * PixelAsHexString(ULong_t pixel)
Convert machine dependent pixel value (obtained via RGB2Pixel or via Number2Pixel() or via TColor::Ge...
Definition TColor.cxx:2349
void Allocate()
Make this color known to the graphics system.
Definition TColor.cxx:1822
ULong_t GetPixel() const
Return pixel value corresponding to this color.
Definition TColor.cxx:1510
static Int_t CreateColorTableFromFile(TString fileName, Float_t alpha=1.)
Static function creating a color palette based on an input text file.
Definition TColor.cxx:2443
static void SetColorThreshold(Float_t t)
This method specifies the color threshold used by GetColor to retrieve a color.
Definition TColor.cxx:1906
static Bool_t DefinedColors(Int_t set_always_on=0)
Static method returning kTRUE if some new colors have been defined after initialisation or since the ...
Definition TColor.cxx:1488
Float_t GetLight() const
Definition TColor.h:64
Float_t GetHue() const
Definition TColor.h:63
Float_t fGreen
Fraction of Green.
Definition TColor.h:26
static void CreateColorsCircle(Int_t offset, const char *name, UChar_t *rgb)
Create the "circle" colors in the color wheel.
Definition TColor.cxx:1327
Int_t GetNumber() const
Definition TColor.h:58
Float_t GetBlue() const
Definition TColor.h:62
TColor & operator=(const TColor &color)
Definition TColor.cxx:1136
Float_t GetGreen() const
Definition TColor.h:61
static Int_t GetNumberOfColors()
Static function returning number of colors in the color palette.
Definition TColor.cxx:1475
static Int_t GetFreeColorIndex()
Static function: Returns a free color index which can be used to define a user custom color.
Definition TColor.cxx:2245
Float_t GetSaturation() const
Definition TColor.h:65
static void HLStoRGB(Float_t h, Float_t l, Float_t s, Float_t &r, Float_t &g, Float_t &b)
Definition TColor.h:76
TColor()
Default constructor.
Definition TColor.cxx:1044
Int_t fNumber
Color number identifier.
Definition TColor.h:23
static void CreateColorsRectangle(Int_t offset, const char *name, UChar_t *rgb)
Create the "rectangular" colors in the color wheel.
Definition TColor.cxx:1347
Float_t fBlue
Fraction of Blue.
Definition TColor.h:27
static void CreateColorsGray()
Create the Gray scale colors in the Color Wheel.
Definition TColor.cxx:1311
virtual void SetAlpha(Float_t a)
Definition TColor.h:70
virtual Float_t GetGrayscale() const
Definition TColor.h:67
virtual ~TColor()
Color destructor.
Definition TColor.cxx:1119
Float_t fRed
Fraction of Red.
Definition TColor.h:25
static void RGB2HLS(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s)
Static method to compute HLS from RGB.
Definition TColor.cxx:1667
static Int_t GetColorTransparent(Int_t color, Float_t a)
Static function: Returns the transparent color number corresponding to n.
Definition TColor.cxx:2056
static void SetGrayscale(Bool_t set=kTRUE)
Set whether all colors should return grayscale values.
Definition TColor.cxx:2411
The TNamed class is the base class for all named ROOT classes.
Definition TNamed.h:29
Mother of all ROOT objects.
Definition TObject.h:41
Basic string class.
Definition TString.h:139
TLine l
Definition textangle.C:4