Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TColorGradient Class Reference

TColorGradient extends basic TColor.

Actually, this is not a simple color, but linear gradient + shadow for filled area. By inheriting from TColor, gradients can be placed inside gROOT's list of colors and use it in all TAttXXX descendants without modifying any existing code.

Shadow, of course, is not a property of any color, and gradient is not, but this is the best way to add new attributes to filled area without re-writing all the graphics code.

Definition at line 35 of file TColorGradient.h.

Classes

struct  Point
 

Public Types

enum  ECoordinateMode { kPadMode , kObjectBoundingMode }
 
typedef std::vector< Color_t >::size_type SizeType_t
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 

Public Member Functions

const Double_tGetColorPositions () const
 Get color positions.
 
const Double_tGetColors () const
 Get colors.
 
ECoordinateMode GetCoordinateMode () const
 Get coordinate mode.
 
SizeType_t GetNumberOfSteps () const
 Get number of steps.
 
void ResetColor (UInt_t nPoints, const Double_t *points, const Color_t *colorIndices)
 Reset color.
 
void ResetColor (UInt_t nPoints, const Double_t *points, const Double_t *colorIndices)
 Reset color.
 
void SetCoordinateMode (ECoordinateMode mode)
 Set coordinate mode.
 
- Public Member Functions inherited from TColor
 TColor ()
 Default constructor.
 
 TColor (const TColor &color)
 Color copy constructor.
 
 TColor (Float_t r, Float_t g, Float_t b, Float_t a=1)
 Fast TColor constructor.
 
 TColor (Int_t color, Float_t r, Float_t g, Float_t b, const char *name="", Float_t a=1)
 Normal color constructor.
 
virtual ~TColor ()
 Color destructor.
 
const char * AsHexString () const
 Return color as hexadecimal string.
 
void Copy (TObject &color) const
 Copy this color to obj.
 
Float_t GetAlpha () const
 
Float_t GetBlue () const
 
virtual Float_t GetGrayscale () const
 
Float_t GetGreen () const
 
virtual void GetHLS (Float_t &h, Float_t &l, Float_t &s) const
 
Float_t GetHue () const
 
Float_t GetLight () const
 
Int_t GetNumber () const
 
ULong_t GetPixel () const
 Return pixel value corresponding to this color.
 
Float_t GetRed () const
 
virtual void GetRGB (Float_t &r, Float_t &g, Float_t &b) const
 
Float_t GetSaturation () const
 
virtual void ls (Option_t *option="") const
 List this color with its attributes.
 
TColoroperator= (const TColor &color)
 
virtual void Print (Option_t *option="") const
 Dump this color with its attributes.
 
virtual void SetAlpha (Float_t a)
 
virtual void SetRGB (Float_t r, Float_t g, Float_t b)
 Initialize this color and its associated colors.
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
virtual Bool_t IsSortable () const
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification.
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Protected Member Functions

 TColorGradient ()
 Constructor.
 
 TColorGradient (Color_t newColor, UInt_t nPoints, const Double_t *points, const Color_t *colorIndices, ECoordinateMode mode=kObjectBoundingMode)
 There is no way to validate parameters here, so it's up to user to pass correct arguments.
 
 TColorGradient (Color_t newColor, UInt_t nPoints, const Double_t *points, const Double_t *colors, ECoordinateMode mode=kObjectBoundingMode)
 There is no way to validate parameters here, so it's up to user to pass correct arguments.
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

Private Member Functions

void RegisterColor (Color_t colorIndex)
 Register color.
 

Private Attributes

std::vector< Double_tfColorPositions
 
std::vector< Double_tfColors
 
ECoordinateMode fCoordinateMode
 

Additional Inherited Members

- Static Public Member Functions inherited from TColor
static void CreateColorsCircle (Int_t offset, const char *name, UChar_t *rgb)
 Create the "circle" colors in the color wheel.
 
static void CreateColorsGray ()
 Create the Gray scale colors in the Color Wheel.
 
static void CreateColorsRectangle (Int_t offset, const char *name, UChar_t *rgb)
 Create the "rectangular" colors in the color wheel.
 
static Int_t CreateColorTableFromFile (TString fileName, Float_t alpha=1.)
 Static function creating a color palette based on an input text file.
 
static void CreateColorWheel ()
 Static function steering the creation of all colors in the color wheel.
 
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.
 
static Bool_t DefinedColors ()
 Static function returning kTRUE if some new colors have been defined after initialisation or since the last call to this method.
 
static Int_t GetColor (const char *hexcolor)
 Static method returning color number for color specified by hex color string of form: "#rrggbb", where rr, gg and bb are in hex between [0,FF], e.g.
 
static Int_t GetColor (Float_t r, Float_t g, Float_t b)
 Static method returning color number for color specified by r, g and b.
 
static Int_t GetColor (Int_t r, Int_t g, Int_t b)
 Static method returning color number for color specified by r, g and b.
 
static Int_t GetColor (ULong_t pixel)
 Static method returning color number for color specified by system dependent pixel value.
 
static Int_t GetColorBright (Int_t color)
 Static function: Returns the bright color number corresponding to n If the TColor object does not exist, it is created.
 
static Int_t GetColorDark (Int_t color)
 Static function: Returns the dark color number corresponding to n If the TColor object does not exist, it is created.
 
static Int_t GetColorPalette (Int_t i)
 Static function returning the color number i in current palette.
 
static Int_t GetColorTransparent (Int_t color, Float_t a)
 Static function: Returns the transparent color number corresponding to n.
 
static Int_t GetFreeColorIndex ()
 Static function: Returns a free color index which can be used to define a user custom color.
 
static Int_t GetNumberOfColors ()
 Static function returning number of colors in the color palette.
 
static const TArrayIGetPalette ()
 Static function returning the current active palette.
 
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.
 
static void HLS2RGB (Int_t h, Int_t l, Int_t s, Int_t &r, Int_t &g, Int_t &b)
 Static method to compute RGB from HLS.
 
static void HLStoRGB (Float_t h, Float_t l, Float_t s, Float_t &r, Float_t &g, Float_t &b)
 
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:
 
static void InitializeColors ()
 Initialize colors used by the TCanvas based graphics (via TColor objects).
 
static void InvertPalette ()
 Invert the current color palette.
 
static Bool_t IsGrayscale ()
 Return whether all colors return grayscale values.
 
static ULong_t Number2Pixel (Int_t ci)
 Static method that given a color index number, returns the corresponding pixel value.
 
static void Pixel2RGB (ULong_t pixel, Float_t &r, Float_t &g, Float_t &b)
 Convert machine dependent pixel value (obtained via RGB2Pixel or via Number2Pixel() or via TColor::GetPixel()) to r,g,b triplet.
 
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::GetPixel()) to r,g,b triplet.
 
static const char * PixelAsHexString (ULong_t pixel)
 Convert machine dependent pixel value (obtained via RGB2Pixel or via Number2Pixel() or via TColor::GetPixel()) to a hexadecimal string.
 
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.
 
static void RGB2HLS (Int_t r, Int_t g, Int_t b, Int_t &h, Int_t &l, Int_t &s)
 Static method to compute HLS from RGB.
 
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.
 
static ULong_t RGB2Pixel (Float_t r, Float_t g, Float_t b)
 Convert r,g,b to graphics system dependent pixel value.
 
static ULong_t RGB2Pixel (Int_t r, Int_t g, Int_t b)
 Convert r,g,b to graphics system dependent pixel value.
 
static void RGBtoHLS (Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s)
 
static void SaveColor (std::ostream &out, Int_t ci)
 Save a color with index > 228 as a C++ statement(s) on output stream out.
 
static void SetColorThreshold (Float_t t)
 This method specifies the color threshold used by GetColor to retrieve a color.
 
static void SetGrayscale (Bool_t set=kTRUE)
 Set whether all colors should return grayscale values.
 
static void SetPalette (Int_t ncolors, Int_t *colors, Float_t alpha=1.)
 Static function.
 
- Static Public Member Functions inherited from TObject
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- Protected Attributes inherited from TColor
Int_t fNumber
 Color number identifier.
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TColorGradient.h>

Inheritance diagram for TColorGradient:
[legend]

Member Typedef Documentation

◆ SizeType_t

typedef std::vector<Color_t>::size_type TColorGradient::SizeType_t

Definition at line 37 of file TColorGradient.h.

Member Enumeration Documentation

◆ ECoordinateMode

Enumerator
kPadMode 
kObjectBoundingMode 

Definition at line 44 of file TColorGradient.h.

Constructor & Destructor Documentation

◆ TColorGradient() [1/3]

TColorGradient::TColorGradient ( )
protected

Constructor.

Definition at line 40 of file TColorGradient.cxx.

◆ TColorGradient() [2/3]

TColorGradient::TColorGradient ( Color_t  newColor,
UInt_t  nPoints,
const Double_t points,
const Color_t colorIndices,
ECoordinateMode  mode = kObjectBoundingMode 
)
protected

There is no way to validate parameters here, so it's up to user to pass correct arguments.

Definition at line 49 of file TColorGradient.cxx.

◆ TColorGradient() [3/3]

TColorGradient::TColorGradient ( Color_t  newColor,
UInt_t  nPoints,
const Double_t points,
const Double_t colors,
ECoordinateMode  mode = kObjectBoundingMode 
)
protected

There is no way to validate parameters here, so it's up to user to pass correct arguments.

Definition at line 65 of file TColorGradient.cxx.

Member Function Documentation

◆ GetColorPositions()

const Double_t * TColorGradient::GetColorPositions ( ) const

Get color positions.

Definition at line 151 of file TColorGradient.cxx.

◆ GetColors()

const Double_t * TColorGradient::GetColors ( ) const

Get colors.

Definition at line 159 of file TColorGradient.cxx.

◆ GetCoordinateMode()

TColorGradient::ECoordinateMode TColorGradient::GetCoordinateMode ( ) const

Get coordinate mode.

Definition at line 135 of file TColorGradient.cxx.

◆ GetNumberOfSteps()

TColorGradient::SizeType_t TColorGradient::GetNumberOfSteps ( ) const

Get number of steps.

Definition at line 143 of file TColorGradient.cxx.

◆ RegisterColor()

void TColorGradient::RegisterColor ( Color_t  colorIndex)
private

Register color.

Definition at line 167 of file TColorGradient.cxx.

◆ ResetColor() [1/2]

void TColorGradient::ResetColor ( UInt_t  nPoints,
const Double_t points,
const Color_t colorIndices 
)

Reset color.

Definition at line 80 of file TColorGradient.cxx.

◆ ResetColor() [2/2]

void TColorGradient::ResetColor ( UInt_t  nPoints,
const Double_t points,
const Double_t colorIndices 
)

Reset color.

Definition at line 113 of file TColorGradient.cxx.

◆ SetCoordinateMode()

void TColorGradient::SetCoordinateMode ( ECoordinateMode  mode)

Set coordinate mode.

Definition at line 127 of file TColorGradient.cxx.

Member Data Documentation

◆ fColorPositions

std::vector<Double_t> TColorGradient::fColorPositions
private

Definition at line 66 of file TColorGradient.h.

◆ fColors

std::vector<Double_t> TColorGradient::fColors
private

Definition at line 67 of file TColorGradient.h.

◆ fCoordinateMode

ECoordinateMode TColorGradient::fCoordinateMode
private

Definition at line 70 of file TColorGradient.h.

  • core/base/inc/TColorGradient.h
  • core/base/src/TColorGradient.cxx