ROOT  6.06/09
Reference Guide
Public Member Functions | Private Attributes | List of all members
TLinearGradient Class Reference

Define a linear color gradient.

Definition at line 103 of file TColorGradient.h.

Public Member Functions

 TLinearGradient ()
 
 TLinearGradient (Color_t newColor, UInt_t nPoints, const Double_t *points, const Color_t *colorIndices, ECoordinateMode mode=kObjectBoundingMode)
 Constructor. More...
 
 TLinearGradient (Color_t newColor, UInt_t nPoints, const Double_t *points, const Double_t *colors, ECoordinateMode mode=kObjectBoundingMode)
 Constructor. More...
 
void SetStartEnd (const Point &p1, const Point &p2)
 Set end and start. More...
 
const PointGetStart () const
 Get start. More...
 
const PointGetEnd () const
 Get end. More...
 
- Public Member Functions inherited from TColorGradient
void ResetColor (UInt_t nPoints, const Double_t *points, const Color_t *colorIndices)
 Reset color. More...
 
void ResetColor (UInt_t nPoints, const Double_t *points, const Double_t *colorIndices)
 Reset color. More...
 
void SetCoordinateMode (ECoordinateMode mode)
 Set coordinate mode. More...
 
ECoordinateMode GetCoordinateMode () const
 Get coordinate mode. More...
 
SizeType_t GetNumberOfSteps () const
 Get number of steps. More...
 
const Double_tGetColorPositions () const
 Get color positions. More...
 
const Double_tGetColors () const
 Get colors. More...
 
- Public Member Functions inherited from TColor
 TColor ()
 Default constructor. More...
 
 TColor (Int_t color, Float_t r, Float_t g, Float_t b, const char *name="", Float_t a=1)
 Normal color constructor. More...
 
 TColor (Float_t r, Float_t g, Float_t b, Float_t a=1)
 Fast TColor constructor. More...
 
 TColor (const TColor &color)
 Color copy constructor. More...
 
virtual ~TColor ()
 Color destructor. More...
 
const char * AsHexString () const
 Return color as hexadecimal string. More...
 
void Copy (TObject &color) const
 Copy this color to obj. More...
 
virtual void GetRGB (Float_t &r, Float_t &g, Float_t &b) const
 
virtual void GetHLS (Float_t &h, Float_t &l, Float_t &s) const
 
Int_t GetNumber () const
 
ULong_t GetPixel () const
 Return pixel value corresponding to this color. More...
 
Float_t GetRed () const
 
Float_t GetGreen () const
 
Float_t GetBlue () const
 
Float_t GetHue () const
 
Float_t GetLight () const
 
Float_t GetSaturation () const
 
Float_t GetAlpha () const
 
virtual Float_t GetGrayscale () const
 
virtual void ls (Option_t *option="") const
 List this color with its attributes. More...
 
virtual void Print (Option_t *option="") const
 Dump this color with its attributes. More...
 
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. More...
 
- 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 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 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 Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. 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 char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
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 Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. 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...
 

Private Attributes

Point fStart
 
Point fEnd
 

Additional Inherited Members

- Public Types inherited from TColorGradient
enum  ECoordinateMode { kPadMode, kObjectBoundingMode }
 
typedef std::vector< Color_t >::size_type SizeType_t
 
- 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 TColor
static void CreateColorWheel ()
 Static function steering the creation of all colors in the color wheel. More...
 
static void CreateColorsGray ()
 Create the Gray scale colors in the Color Wheel. More...
 
static void CreateColorsCircle (Int_t offset, const char *name, UChar_t *rgb)
 Create the "circle" colors in the color wheel. More...
 
static void CreateColorsRectangle (Int_t offset, const char *name, UChar_t *rgb)
 Create the "rectangular" colors in the color wheel. More...
 
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. More...
 
static Int_t GetColorPalette (Int_t i)
 Static function returning the color number i in current palette. More...
 
static Int_t GetNumberOfColors ()
 Static function returning number of colors in the color palette. More...
 
static void InitializeColors ()
 Initialize colors used by the TCanvas based graphics (via TColor objects). More...
 
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. More...
 
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. More...
 
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: More...
 
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. More...
 
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. More...
 
static void RGBtoHLS (Float_t r, Float_t g, Float_t b, Float_t &h, Float_t &l, Float_t &s)
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static Int_t GetColor (ULong_t pixel)
 Static method returning color number for color specified by system dependent pixel value. More...
 
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. More...
 
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. More...
 
static Int_t GetColorTransparent (Int_t color, Float_t a)
 Static function: Returns the transparent color number corresponding to n. More...
 
static ULong_t Number2Pixel (Int_t ci)
 Static method that given a color index number, returns the corresponding pixel value. More...
 
static ULong_t RGB2Pixel (Int_t r, Int_t g, Int_t b)
 Convert r,g,b to graphics system dependent pixel value. More...
 
static ULong_t RGB2Pixel (Float_t r, Float_t g, Float_t b)
 Convert r,g,b to graphics system dependent pixel value. More...
 
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. More...
 
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. More...
 
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. More...
 
static void SaveColor (std::ostream &out, Int_t ci)
 Save a color with index > 228 as a C++ statement(s) on output stream out. More...
 
static Bool_t IsGrayscale ()
 Return whether all colors return grayscale values. More...
 
static void SetGrayscale (Bool_t set=kTRUE)
 Set whether all colors should return grayscale values. More...
 
static void SetPalette (Int_t ncolors, Int_t *colors, Float_t alpha=1.)
 Static function. More...
 
- 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 Member Functions inherited from TColorGradient
 TColorGradient ()
 
 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. More...
 
 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. 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...
 
- Protected Attributes inherited from TColor
Int_t fNumber
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TColorGradient.h>

+ Inheritance diagram for TLinearGradient:
+ Collaboration diagram for TLinearGradient:

Constructor & Destructor Documentation

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

Constructor.

Definition at line 197 of file TColorGradient.cxx.

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

Constructor.

Definition at line 206 of file TColorGradient.cxx.

Member Function Documentation

const TColorGradient::Point & TLinearGradient::GetEnd ( ) const

Get end.

Definition at line 232 of file TColorGradient.cxx.

Referenced by TGLPadPainter::DrawGradient().

const TColorGradient::Point & TLinearGradient::GetStart ( ) const

Get start.

Definition at line 224 of file TColorGradient.cxx.

Referenced by TGLPadPainter::DrawGradient().

void TLinearGradient::SetStartEnd ( const Point p1,
const Point p2 
)

Set end and start.

Definition at line 215 of file TColorGradient.cxx.

Member Data Documentation

Point TLinearGradient::fEnd
private

Definition at line 119 of file TColorGradient.h.

Referenced by GetEnd(), and SetStartEnd().

Point TLinearGradient::fStart
private

Definition at line 118 of file TColorGradient.h.

Referenced by GetStart(), and SetStartEnd().


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