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

Draw the ROOT Color Wheel.

The wheel contains the recommended 216 colors to be used in web applications. The colors in the Color Wheel are created by TColor::CreateColorWheel.

Using this color set for your text, background or graphics will give your application a consistent appearance across different platforms and browsers.

Colors are grouped by hue, the aspect most important in human perception. Touching color chips have the same hue, but with different brightness and vividness.

Colors of slightly different hues clash. If you intend to display colors of the same hue together, you should pick them from the same group.

Each color chip is identified by a mnemonic (e.g. kYellow) and a number. The keywords, kRed, kBlue, kYellow, kPink, etc are defined in the header file Rtypes.h that is included in all ROOT other header files. We strongly recommend to use these keywords in your code instead of hardcoded color numbers, e.g.:

myObject.SetFillColor(kRed);
myObject.SetFillColor(kYellow-10);
myLine.SetLineColor(kMagenta+2);
@ kRed
Definition Rtypes.h:66
@ kMagenta
Definition Rtypes.h:66
@ kYellow
Definition Rtypes.h:66

Definition at line 23 of file TColorWheel.h.

Public Member Functions

 TColorWheel ()
 constructor
 
 ~TColorWheel () override
 destructor
 
Int_t DistancetoPrimitive (Int_t px, Int_t py) override
 always return the color wheel
 
void Draw (Option_t *option="") override
 Paint the color wheel.
 
TCanvasGetCanvas () const
 
virtual Int_t GetColor (Int_t px, Int_t py) const
 Return the color number pointed by the mouse.
 
char * GetObjectInfo (Int_t px, Int_t py) const override
 Return the color number pointed by the mouse.
 
TClassIsA () const override
 
void Paint (Option_t *option="") override
 Paint the color wheel.
 
virtual void SetCanvas (TCanvas *can)
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
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.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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 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 with: gROOT->SetSelectedPad(c1).
 
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=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 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 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 (the base implementation is no-op).
 
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 [].
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
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.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
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 Member Functions

Int_t InCircles (Double_t x, Double_t y, Int_t coffset, Double_t angle) const
 Return the color number when the mouse point to a circle.
 
Int_t InGray (Double_t x, Double_t y) const
 Return the color number when the mouse point to the gray circle.
 
Int_t InRectangles (Double_t x, Double_t y, Int_t coffset, Double_t angle) const
 Return the color number when the mouse point to a rectangle.
 
void PaintCircle (Int_t coffset, Int_t n, Double_t x, Double_t y, Double_t ang) const
 Draw one color of type circle.
 
void PaintCircles (Int_t coffset, Double_t angle) const
 Draw all colors of type circle.
 
void PaintGray () const
 Draw the gray colors + white + black.
 
void PaintRectangles (Int_t coffset, Double_t angle) const
 Draw all colors of type rectangle.
 
void Rotate (Double_t x, Double_t y, Double_t &u, Double_t &v, Double_t ang) const
 Rotate point x,y with an angle=ang.
 
- 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

 TColorWheel (const TColorWheel &)=delete
 
TColorWheeloperator= (const TColorWheel &)=delete
 

Private Attributes

TArcfArc {nullptr}
 ! pointer to utility arc
 
TCanvasfCanvas {nullptr}
 ! Canvas used to draw the Color Wheel
 
Double_t fDr {0.}
 Circles radius.
 
TGraphfGraph {nullptr}
 ! pointer to utility graph
 
TLinefLine {nullptr}
 ! pointer to utility line
 
Double_t fR0 {0.}
 Minimum radius for circles.
 
Double_t fRgray {0.}
 Maximum radius of gray circle.
 
Double_t fRmax {0.}
 Maximum radius for rectangles.
 
Double_t fRmin {0.}
 Minimum radius for rectangles.
 
TTextfText {nullptr}
 ! pointer to utility text
 
Double_t fX [15]
 X coordinates of the center of circles.
 
Double_t fY [15]
 Y coordinates of the center of circles.
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TColorWheel.h>

Inheritance diagram for TColorWheel:
[legend]

Constructor & Destructor Documentation

◆ TColorWheel() [1/2]

TColorWheel::TColorWheel ( const TColorWheel )
privatedelete

◆ TColorWheel() [2/2]

TColorWheel::TColorWheel ( )

constructor

Definition at line 65 of file TColorWheel.cxx.

◆ ~TColorWheel()

TColorWheel::~TColorWheel ( )
override

destructor

Definition at line 94 of file TColorWheel.cxx.

Member Function Documentation

◆ Class()

static TClass * TColorWheel::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TColorWheel::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TColorWheel::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 63 of file TColorWheel.h.

◆ DeclFileName()

static const char * TColorWheel::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 63 of file TColorWheel.h.

◆ DistancetoPrimitive()

Int_t TColorWheel::DistancetoPrimitive ( Int_t  px,
Int_t  py 
)
overridevirtual

always return the color wheel

Reimplemented from TObject.

Definition at line 106 of file TColorWheel.cxx.

◆ Draw()

void TColorWheel::Draw ( Option_t option = "")
overridevirtual

Paint the color wheel.

Reimplemented from TObject.

Definition at line 115 of file TColorWheel.cxx.

◆ GetCanvas()

TCanvas * TColorWheel::GetCanvas ( ) const
inline

Definition at line 57 of file TColorWheel.h.

◆ GetColor()

Int_t TColorWheel::GetColor ( Int_t  px,
Int_t  py 
) const
virtual

Return the color number pointed by the mouse.

Definition at line 130 of file TColorWheel.cxx.

◆ GetObjectInfo()

char * TColorWheel::GetObjectInfo ( Int_t  px,
Int_t  py 
) const
overridevirtual

Return the color number pointed by the mouse.

Reimplemented from TObject.

Definition at line 155 of file TColorWheel.cxx.

◆ InCircles()

Int_t TColorWheel::InCircles ( Double_t  x,
Double_t  y,
Int_t  coffset,
Double_t  angle 
) const
protected

Return the color number when the mouse point to a circle.

Definition at line 177 of file TColorWheel.cxx.

◆ InGray()

Int_t TColorWheel::InGray ( Double_t  x,
Double_t  y 
) const
protected

Return the color number when the mouse point to the gray circle.

Definition at line 194 of file TColorWheel.cxx.

◆ InRectangles()

Int_t TColorWheel::InRectangles ( Double_t  x,
Double_t  y,
Int_t  coffset,
Double_t  angle 
) const
protected

Return the color number when the mouse point to a rectangle.

Definition at line 210 of file TColorWheel.cxx.

◆ IsA()

TClass * TColorWheel::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 63 of file TColorWheel.h.

◆ operator=()

TColorWheel & TColorWheel::operator= ( const TColorWheel )
privatedelete

◆ Paint()

void TColorWheel::Paint ( Option_t option = "")
overridevirtual

Paint the color wheel.

Reimplemented from TObject.

Definition at line 225 of file TColorWheel.cxx.

◆ PaintCircle()

void TColorWheel::PaintCircle ( Int_t  coffset,
Int_t  n,
Double_t  x,
Double_t  y,
Double_t  ang 
) const
protected

Draw one color of type circle.

Definition at line 258 of file TColorWheel.cxx.

◆ PaintCircles()

void TColorWheel::PaintCircles ( Int_t  coffset,
Double_t  angle 
) const
protected

Draw all colors of type circle.

Definition at line 279 of file TColorWheel.cxx.

◆ PaintGray()

void TColorWheel::PaintGray ( ) const
protected

Draw the gray colors + white + black.

Definition at line 389 of file TColorWheel.cxx.

◆ PaintRectangles()

void TColorWheel::PaintRectangles ( Int_t  coffset,
Double_t  angle 
) const
protected

Draw all colors of type rectangle.

Definition at line 306 of file TColorWheel.cxx.

◆ Rotate()

void TColorWheel::Rotate ( Double_t  x,
Double_t  y,
Double_t u,
Double_t v,
Double_t  ang 
) const
protected

Rotate point x,y with an angle=ang.

Definition at line 428 of file TColorWheel.cxx.

◆ SetCanvas()

virtual void TColorWheel::SetCanvas ( TCanvas can)
inlinevirtual

Definition at line 61 of file TColorWheel.h.

◆ Streamer()

void TColorWheel::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TColorWheel::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 63 of file TColorWheel.h.

Member Data Documentation

◆ fArc

TArc* TColorWheel::fArc {nullptr}
private

! pointer to utility arc

Definition at line 34 of file TColorWheel.h.

◆ fCanvas

TCanvas* TColorWheel::fCanvas {nullptr}
private

! Canvas used to draw the Color Wheel

Definition at line 33 of file TColorWheel.h.

◆ fDr

Double_t TColorWheel::fDr {0.}
private

Circles radius.

Definition at line 29 of file TColorWheel.h.

◆ fGraph

TGraph* TColorWheel::fGraph {nullptr}
private

! pointer to utility graph

Definition at line 37 of file TColorWheel.h.

◆ fLine

TLine* TColorWheel::fLine {nullptr}
private

! pointer to utility line

Definition at line 35 of file TColorWheel.h.

◆ fR0

Double_t TColorWheel::fR0 {0.}
private

Minimum radius for circles.

Definition at line 28 of file TColorWheel.h.

◆ fRgray

Double_t TColorWheel::fRgray {0.}
private

Maximum radius of gray circle.

Definition at line 30 of file TColorWheel.h.

◆ fRmax

Double_t TColorWheel::fRmax {0.}
private

Maximum radius for rectangles.

Definition at line 27 of file TColorWheel.h.

◆ fRmin

Double_t TColorWheel::fRmin {0.}
private

Minimum radius for rectangles.

Definition at line 26 of file TColorWheel.h.

◆ fText

TText* TColorWheel::fText {nullptr}
private

! pointer to utility text

Definition at line 36 of file TColorWheel.h.

◆ fX

Double_t TColorWheel::fX[15]
private

X coordinates of the center of circles.

Definition at line 31 of file TColorWheel.h.

◆ fY

Double_t TColorWheel::fY[15]
private

Y coordinates of the center of circles.

Definition at line 32 of file TColorWheel.h.

Libraries for TColorWheel:

The documentation for this class was generated from the following files: