ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
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);
TColorWheel_001.png

Definition at line 34 of file TColorWheel.h.

Public Member Functions

 TColorWheel ()
 
virtual ~TColorWheel ()
 destructor More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 always return the color wheel More...
 
virtual void Draw (Option_t *option="")
 Paint the color wheel. More...
 
TCanvasGetCanvas () const
 
virtual Int_t GetColor (Int_t px, Int_t py) const
 Return the color number pointed by the mouse. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Return the color number pointed by the mouse. More...
 
virtual void Paint (Option_t *option="")
 Paint the color wheel. More...
 
virtual void SetCanvas (TCanvas *can)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
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). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

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. More...
 
Int_t InGray (Double_t x, Double_t y) const
 Return the color number when the mouse point to the gray circle. More...
 
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. More...
 
void PaintCircle (Int_t coffset, Int_t n, Double_t x, Double_t y, Double_t ang) const
 Draw one color of type circle. More...
 
void PaintCircles (Int_t coffset, Double_t angle) const
 Draw all colors of type circle. More...
 
void PaintGray () const
 Draw the gray colors + white + black. More...
 
void PaintRectangles (Int_t coffset, Double_t angle) const
 Draw all colors of type rectangle. More...
 
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. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Private Member Functions

 TColorWheel (const TColorWheel &org)
 pointer to utility graph More...
 
TColorWheeloperator= (const TColorWheel &rhs)
 

Private Attributes

Double_t fRmin
 
Double_t fRmax
 
Double_t fR0
 
Double_t fDr
 
Double_t fRgray
 
Double_t fX [15]
 
Double_t fY [15]
 
TCanvasfCanvas
 
TArcfArc
 Canvas used to draw the Color Wheel. More...
 
TLinefLine
 pointer to utility arc More...
 
TTextfText
 pointer to utility line More...
 
TGraphfGraph
 pointer to utility text More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TColorWheel.h>

+ Inheritance diagram for TColorWheel:
+ Collaboration diagram for TColorWheel:

Constructor & Destructor Documentation

TColorWheel::TColorWheel ( const TColorWheel org)
private

pointer to utility graph

TColorWheel::TColorWheel ( )
TColorWheel::~TColorWheel ( )
virtual

destructor

Definition at line 97 of file TColorWheel.cxx.

Member Function Documentation

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

always return the color wheel

Reimplemented from TObject.

Definition at line 109 of file TColorWheel.cxx.

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

Paint the color wheel.

Reimplemented from TObject.

Definition at line 118 of file TColorWheel.cxx.

Referenced by TRootCanvas::ProcessMessage(), and TGColorDialog::TGColorDialog().

TCanvas* TColorWheel::GetCanvas ( ) const
inline

Definition at line 68 of file TColorWheel.h.

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

Return the color number pointed by the mouse.

Definition at line 133 of file TColorWheel.cxx.

Referenced by GetObjectInfo(), and TGColorDialog::SetColorInfo().

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

Return the color number pointed by the mouse.

Reimplemented from TObject.

Definition at line 158 of file TColorWheel.cxx.

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.

Referenced by GetColor().

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.

Referenced by GetColor().

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.

Referenced by GetColor().

TColorWheel& TColorWheel::operator= ( const TColorWheel rhs)
private
void TColorWheel::Paint ( Option_t option = "")
virtual

Paint the color wheel.

Reimplemented from TObject.

Definition at line 225 of file TColorWheel.cxx.

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.

Referenced by 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.

Referenced by Paint().

void TColorWheel::PaintGray ( ) const
protected

Draw the gray colors + white + black.

Definition at line 389 of file TColorWheel.cxx.

Referenced by Paint().

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.

Referenced by Paint().

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.

Referenced by InCircles(), InRectangles(), PaintCircle(), PaintCircles(), and PaintRectangles().

virtual void TColorWheel::SetCanvas ( TCanvas can)
inlinevirtual

Definition at line 72 of file TColorWheel.h.

Referenced by TGColorDialog::TGColorDialog().

Member Data Documentation

TArc* TColorWheel::fArc
private

Canvas used to draw the Color Wheel.

Definition at line 45 of file TColorWheel.h.

Referenced by Paint(), PaintCircle(), PaintGray(), and ~TColorWheel().

TCanvas* TColorWheel::fCanvas
private

Definition at line 44 of file TColorWheel.h.

Referenced by Draw(), GetCanvas(), and GetColor().

Double_t TColorWheel::fDr
private

Definition at line 40 of file TColorWheel.h.

Referenced by InCircles(), PaintCircle(), and PaintCircles().

TGraph* TColorWheel::fGraph
private

pointer to utility text

Definition at line 48 of file TColorWheel.h.

Referenced by Paint(), PaintRectangles(), and ~TColorWheel().

TLine* TColorWheel::fLine
private

pointer to utility arc

Definition at line 46 of file TColorWheel.h.

Referenced by Paint(), PaintCircles(), PaintRectangles(), and ~TColorWheel().

Double_t TColorWheel::fR0
private

Definition at line 39 of file TColorWheel.h.

Referenced by PaintCircles().

Double_t TColorWheel::fRgray
private

Definition at line 41 of file TColorWheel.h.

Referenced by InGray(), and PaintGray().

Double_t TColorWheel::fRmax
private

Definition at line 38 of file TColorWheel.h.

Referenced by InRectangles(), and PaintRectangles().

Double_t TColorWheel::fRmin
private

Definition at line 37 of file TColorWheel.h.

Referenced by InRectangles(), and PaintRectangles().

TText* TColorWheel::fText
private

pointer to utility line

Definition at line 47 of file TColorWheel.h.

Referenced by Paint(), PaintCircle(), PaintCircles(), PaintGray(), PaintRectangles(), and ~TColorWheel().

Double_t TColorWheel::fX[15]
private

Definition at line 42 of file TColorWheel.h.

Referenced by InCircles(), and PaintCircles().

Double_t TColorWheel::fY[15]
private

Definition at line 43 of file TColorWheel.h.

Referenced by InCircles(), and PaintCircles().


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