Logo ROOT  
Reference Guide
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
17class TArrayI;
18
19class TColor : public TNamed {
20protected:
21 Int_t fNumber; ///< Color number identifier
22private:
23 Float_t fRed; ///< Fraction of Red
24 Float_t fGreen; ///< Fraction of Green
25 Float_t fBlue; ///< Fraction of Blue
26 Float_t fHue; ///< Hue
27 Float_t fLight; ///< Light
28 Float_t fSaturation; ///< Saturation
29 Float_t fAlpha; ///< Alpha (transparency)
30
31 void Allocate();
32 static Float_t HLStoRGB1(Float_t rn1, Float_t rn2, Float_t huei);
33
34public:
35 TColor();
36 TColor(Int_t color, Float_t r, Float_t g, Float_t b, const char *name="", Float_t a = 1);
38 TColor(const TColor &color);
39 TColor &operator=(const TColor &color);
40 virtual ~TColor();
41 const char *AsHexString() const;
42 void Copy(TObject &color) const;
43 static void CreateColorWheel();
44 static void CreateColorsGray();
45 static void CreateColorsCircle(Int_t offset, const char *name, UChar_t *rgb);
46 static void CreateColorsRectangle(Int_t offset, const char *name, UChar_t *rgb);
47 static Int_t CreateColorTableFromFile(TString fileName, Float_t alpha=1.);
48 static Int_t CreateGradientColorTable(UInt_t Number, Double_t* Stops,
49 Double_t* Red, Double_t* Green, Double_t* Blue, UInt_t NColors, Float_t alpha=1.);
50 static Int_t GetColorPalette(Int_t i);
51 static Int_t GetNumberOfColors();
52 virtual void GetRGB(Float_t &r, Float_t &g, Float_t &b) const
53 { r=GetRed(); g=GetGreen(); b=GetBlue(); }
54 virtual void GetHLS(Float_t &h, Float_t &l, Float_t &s) const
55 { h=GetHue(); l=GetLight(); s=GetSaturation(); }
56 Int_t GetNumber() const { return fNumber; }
57 ULong_t GetPixel() const;
58 Float_t GetRed() const { return IsGrayscale() ? GetGrayscale() : fRed; }
59 Float_t GetGreen() const { return IsGrayscale() ? GetGrayscale() : fGreen; }
60 Float_t GetBlue() const { return IsGrayscale() ? GetGrayscale() : fBlue; }
61 Float_t GetHue() const { return fHue; }
62 Float_t GetLight() const { return fLight; }
63 Float_t GetSaturation() const { return IsGrayscale() ? 0 : fSaturation; }
64 Float_t GetAlpha() const { return fAlpha; }
65 virtual Float_t GetGrayscale() const { /*ITU*/ return 0.299f*fRed + 0.587f*fGreen + 0.114f*fBlue; }
66 virtual void ls(Option_t *option="") const;
67 virtual void Print(Option_t *option="") const;
68 virtual void SetAlpha(Float_t a) { fAlpha = a; }
69 virtual void SetRGB(Float_t r, Float_t g, Float_t b);
70
71 static void InitializeColors();
72 static void HLS2RGB(Float_t h, Float_t l, Float_t s, Float_t &r, Float_t &g, Float_t &b);
73 static void HLS2RGB(Int_t h, Int_t l, Int_t s, Int_t &r, Int_t &g, Int_t &b);
75 { TColor::HLS2RGB(h, l, s, r, g, b); } // backward compatible
76 static void HSV2RGB(Float_t h, Float_t s, Float_t v, Float_t &r, Float_t &g, Float_t &b);
77 static void RGB2HLS(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s);
78 static void RGB2HLS(Int_t r, Int_t g, Int_t b, Int_t &h, Int_t &l, Int_t &s);
80 { TColor::RGB2HLS(r, g, b, h, l, s); } // backward compatible
81 static void RGB2HSV(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &s, Float_t &v);
82 static Int_t GetColor(const char *hexcolor);
84 static Int_t GetColor(Int_t r, Int_t g, Int_t b);
85 static Int_t GetColor(ULong_t pixel);
86 static Int_t GetColorBright(Int_t color);
87 static Int_t GetColorDark(Int_t color);
89 static Int_t GetFreeColorIndex();
90 static const TArrayI& GetPalette();
91 static ULong_t Number2Pixel(Int_t ci);
94 static void Pixel2RGB(ULong_t pixel, Int_t &r, Int_t &g, Int_t &b);
95 static void Pixel2RGB(ULong_t pixel, Float_t &r, Float_t &g, Float_t &b);
96 static const char *PixelAsHexString(ULong_t pixel);
97 static void SaveColor(std::ostream &out, Int_t ci);
98 static void SetColorThreshold(Float_t t);
99 static Bool_t DefinedColors();
100 static void InvertPalette();
101 static Bool_t IsGrayscale();
102 static void SetGrayscale(Bool_t set = kTRUE);
103 static void SetPalette(Int_t ncolors, Int_t *colors,Float_t alpha=1.);
104
105 ClassDef(TColor,2) //Color defined by RGB or HLS
106};
107
121 kNeon=90, kPastel=91, kPearl=92,
127 kWaterMelon=108, kCool=109, kCopper=110,
129#endif
130
ROOT::R::TRInterface & r
Definition: Object.C:4
#define b(i)
Definition: RSha256.hxx:100
#define g(i)
Definition: RSha256.hxx:105
#define h(i)
Definition: RSha256.hxx:106
int Int_t
Definition: RtypesCore.h:45
unsigned char UChar_t
Definition: RtypesCore.h:38
unsigned int UInt_t
Definition: RtypesCore.h:46
unsigned long ULong_t
Definition: RtypesCore.h:55
bool Bool_t
Definition: RtypesCore.h:63
double Double_t
Definition: RtypesCore.h:59
float Float_t
Definition: RtypesCore.h:57
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define ClassDef(name, id)
Definition: Rtypes.h:325
EColorPalette
Definition: TColor.h:108
@ kFall
Definition: TColor.h:117
@ kStarryNight
Definition: TColor.h:125
@ kAtlantic
Definition: TColor.h:113
@ kIsland
Definition: TColor.h:119
@ kBlackBody
Definition: TColor.h:114
@ kFruitPunch
Definition: TColor.h:117
@ kArmy
Definition: TColor.h:112
@ kAurora
Definition: TColor.h:113
@ kBrownCyan
Definition: TColor.h:115
@ kBeach
Definition: TColor.h:114
@ kAquamarine
Definition: TColor.h:112
@ kPastel
Definition: TColor.h:121
@ kCubehelix
Definition: TColor.h:110
@ kAvocado
Definition: TColor.h:113
@ kGreenRedViolet
Definition: TColor.h:110
@ kAlpine
Definition: TColor.h:112
@ kVisibleSpectrum
Definition: TColor.h:126
@ kCMYK
Definition: TColor.h:115
@ kInvertedDarkBodyRadiator
Definition: TColor.h:109
@ kWaterMelon
Definition: TColor.h:127
@ kOcean
Definition: TColor.h:111
@ kDarkBodyRadiator
Definition: TColor.h:108
@ kDarkTerrain
Definition: TColor.h:117
@ kLightTemperature
Definition: TColor.h:120
@ kRust
Definition: TColor.h:123
@ kCopper
Definition: TColor.h:127
@ kTemperatureMap
Definition: TColor.h:125
@ kSolar
Definition: TColor.h:124
@ kRedBlue
Definition: TColor.h:122
@ kDeepSea
Definition: TColor.h:108
@ kRainBow
Definition: TColor.h:109
@ kSouthWest
Definition: TColor.h:124
@ kPlum
Definition: TColor.h:122
@ kGreenBrownTerrain
Definition: TColor.h:118
@ kGreyYellow
Definition: TColor.h:118
@ kGreyScale
Definition: TColor.h:108
@ kRose
Definition: TColor.h:123
@ kSunset
Definition: TColor.h:125
@ kCoffee
Definition: TColor.h:116
@ kGreenPink
Definition: TColor.h:119
@ kColorPrintableOnGrey
Definition: TColor.h:111
@ kSienna
Definition: TColor.h:124
@ kBlueYellow
Definition: TColor.h:109
@ kBlueRedYellow
Definition: TColor.h:111
@ kValentine
Definition: TColor.h:126
@ kSandyTerrain
Definition: TColor.h:123
@ kDarkRainBow
Definition: TColor.h:116
@ kViridis
Definition: TColor.h:128
@ kCandy
Definition: TColor.h:115
@ kCherry
Definition: TColor.h:116
@ kNeon
Definition: TColor.h:121
@ kBird
Definition: TColor.h:110
@ kFuchsia
Definition: TColor.h:118
@ kBlueGreenYellow
Definition: TColor.h:114
@ kPearl
Definition: TColor.h:121
@ kPigeon
Definition: TColor.h:122
@ kCividis
Definition: TColor.h:128
@ kCool
Definition: TColor.h:127
@ kLake
Definition: TColor.h:119
@ kMint
Definition: TColor.h:120
@ kGistEarth
Definition: TColor.h:128
@ kThermometer
Definition: TColor.h:126
@ kLightTerrain
Definition: TColor.h:120
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:19
Float_t fSaturation
Saturation.
Definition: TColor.h:28
static void SetPalette(Int_t ncolors, Int_t *colors, Float_t alpha=1.)
Static function.
Definition: TColor.cxx:2541
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:1510
virtual void SetRGB(Float_t r, Float_t g, Float_t b)
Initialize this color and its associated colors.
Definition: TColor.cxx:1758
static void RGBtoHLS(Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s)
Definition: TColor.h:79
static Float_t HLStoRGB1(Float_t rn1, Float_t rn2, Float_t huei)
Static method. Auxiliary to HLS2RGB().
Definition: TColor.cxx:1535
virtual void GetRGB(Float_t &r, Float_t &g, Float_t &b) const
Definition: TColor.h:52
static Int_t GetColorPalette(Int_t i)
Static function returning the color number i in current palette.
Definition: TColor.cxx:1449
static const TArrayI & GetPalette()
Static function returning the current active palette.
Definition: TColor.cxx:1461
Float_t GetRed() const
Definition: TColor.h:58
Float_t fLight
Light.
Definition: TColor.h:27
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:2107
static ULong_t Number2Pixel(Int_t ci)
Static method that given a color index number, returns the corresponding pixel value.
Definition: TColor.cxx:2069
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:1705
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:1822
static void InitializeColors()
Initialize colors used by the TCanvas based graphics (via TColor objects).
Definition: TColor.cxx:1142
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:1576
Float_t fAlpha
Alpha (transparency)
Definition: TColor.h:29
static void InvertPalette()
Invert the current color palette.
Definition: TColor.cxx:3260
Float_t fHue
Hue.
Definition: TColor.h:26
static void CreateColorWheel()
Static function steering the creation of all colors in the color wheel.
Definition: TColor.cxx:1361
virtual void ls(Option_t *option="") const
List this color with its attributes.
Definition: TColor.cxx:1632
virtual void GetHLS(Float_t &h, Float_t &l, Float_t &s) const
Definition: TColor.h:54
static void 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:2174
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:1969
static Bool_t IsGrayscale()
Return whether all colors return grayscale values.
Definition: TColor.cxx:2212
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:2145
const char * AsHexString() const
Return color as hexadecimal string.
Definition: TColor.cxx:1268
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:2001
Float_t GetAlpha() const
Definition: TColor.h:64
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:2162
void Allocate()
Make this color known to the graphics system.
Definition: TColor.cxx:1805
void Copy(TObject &color) const
Copy this color to obj.
Definition: TColor.cxx:1289
ULong_t GetPixel() const
Return pixel value corresponding to this color.
Definition: TColor.cxx:1493
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:2252
static void SetColorThreshold(Float_t t)
This method specifies the color threshold used by GetColor to retrieve a color.
Definition: TColor.cxx:1894
Float_t GetLight() const
Definition: TColor.h:62
Float_t GetHue() const
Definition: TColor.h:61
Float_t fGreen
Fraction of Green.
Definition: TColor.h:24
static void CreateColorsCircle(Int_t offset, const char *name, UChar_t *rgb)
Create the "circle" colors in the color wheel.
Definition: TColor.cxx:1321
Int_t GetNumber() const
Definition: TColor.h:56
Float_t GetBlue() const
Definition: TColor.h:60
TColor & operator=(const TColor &color)
Definition: TColor.cxx:1131
Float_t GetGreen() const
Definition: TColor.h:59
static Int_t GetNumberOfColors()
Static function returning number of colors in the color palette.
Definition: TColor.cxx:1469
static Int_t GetFreeColorIndex()
Static function: Returns a free color index which can be used to define a user custom color.
Definition: TColor.cxx:2058
Float_t GetSaturation() const
Definition: TColor.h:63
static void HLStoRGB(Float_t h, Float_t l, Float_t s, Float_t &r, Float_t &g, Float_t &b)
Definition: TColor.h:74
TColor()
Default constructor.
Definition: TColor.cxx:1039
Int_t fNumber
Color number identifier.
Definition: TColor.h:21
static void CreateColorsRectangle(Int_t offset, const char *name, UChar_t *rgb)
Create the "rectangular" colors in the color wheel.
Definition: TColor.cxx:1341
Float_t fBlue
Fraction of Blue.
Definition: TColor.h:25
static void CreateColorsGray()
Create the Gray scale colors in the Color Wheel.
Definition: TColor.cxx:1305
virtual void SetAlpha(Float_t a)
Definition: TColor.h:68
virtual Float_t GetGrayscale() const
Definition: TColor.h:65
virtual ~TColor()
Color destructor.
Definition: TColor.cxx:1114
virtual void Print(Option_t *option="") const
Dump this color with its attributes.
Definition: TColor.cxx:1641
Float_t fRed
Fraction of Red.
Definition: TColor.h:23
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:1650
static Int_t GetColorTransparent(Int_t color, Float_t a)
Static function: Returns the transparent color number corresponding to n.
Definition: TColor.cxx:2032
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.)
Static function creating a color table with several connected linear gradients.
Definition: TColor.cxx:2352
static Bool_t DefinedColors()
Static function returning kTRUE if some new colors have been defined after initialisation or since th...
Definition: TColor.cxx:1479
static void SetGrayscale(Bool_t set=kTRUE)
Set whether all colors should return grayscale values.
Definition: TColor.cxx:2220
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:136
static constexpr double s
auto * l
Definition: textangle.C:4
auto * a
Definition: textangle.C:12