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

To draw TeX Mathematical Formula.

TMathText's purpose is to write mathematical equations, exactly as TeX would do it. The syntax is the same as the TeX's one.

The following example demonstrate how to use TMathText:

{
TCanvas *c1 = new TCanvas("c1");
l.SetTextAlign(23);
l.SetTextSize(0.06);
l.DrawMathText(0.50, 1.000,
"\\prod_{j\\ge0} \\left(\\sum_{k\\ge0} a_{jk}z^k\\right) = \\sum_{n\\ge0} z^n "
"\\left(\\sum_{k_0,k_1,\\ldots\\ge0\\atop k_0+k_1+\\cdots=n} a_{0k_0}a_{1k_1} \\cdots \\right)");
l.DrawMathText(0.50, 0.800,
"W_{\\delta_1\\rho_1\\sigma_2}^{3\\beta} = U_{\\delta_1\\rho_1\\sigma_2}^{3\\beta} + {1\\over "
"8\\pi^2} \\int_{\\alpha_1}^{\\alpha_2} d\\alpha_2^\\prime \\left[ {U_{\\delta_1\\rho_1}^{2\\beta} - "
"\\alpha_2^\\prime U_{\\rho_1\\sigma_2}^{1\\beta} \\over U_{\\rho_1\\sigma_2}^{0\\beta}} \\right]");
l.DrawMathText(0.50, 0.600,
"d\\Gamma = {1\\over 2m_A} \\left( \\prod_f {d^3p_f\\over (2\\pi)^3} {1\\over 2E_f} \\right) \\left| "
"\\mathscr{M} \\left(m_A - \\left\\{p_f\\right\\} \\right) \\right|^2 (2\\pi)^4 \\delta^{(4)} "
"\\left(p_A - \\sum p_f \\right)");
l.DrawMathText(0.50, 0.425,
"4\\mathrm{Re}\\left\\{{2\\over 1-\\Delta\\alpha} \\chi(s) \\left[ \\^{g}_\\nu^e \\^{g}_\\nu^f (1 + "
"\\cos^2\\theta) + \\^{g}_a^e \\^{g}_a^f \\cos\\theta \\right] \\right\\}");
l.DrawMathText(
0.50, 0.330,
"p(n) = {1\\over\\pi\\sqrt{2}} \\sum_{k = 1}^\\infty \\sqrt{k} A_k(n) {d\\over dn} {\\sinh \\left\\{ {\\pi\\over "
"k} \\sqrt{2\\over 3} \\sqrt{n - {1\\over 24}} \\right\\} \\over \\sqrt{n - {1\\over 24}}}");
l.DrawMathText(0.13, 0.150, "{(\\ell+1)C_{\\ell}^{TE} \\over 2\\pi}");
l.DrawMathText(0.27, 0.110, "\\mathbb{N} \\subset \\mathbb{R}");
l.DrawMathText(0.63, 0.100, "\\hbox{RHIC スピン物理 Нью-Йорк}");
c1->Print("c1.png");
c1->Print("c1.ps");
return c1;
}
The Canvas class.
Definition TCanvas.h:23
TMathText()
Default constructor.
return c1
Definition legend1.C:41
TLine l
Definition textangle.C:4

The list of all available symbols is given in the following example:

End_Macro

Limitation:

TMathText rendering is not implemented for the PDF output. PostScript output should be used instead.

Definition at line 19 of file TMathText.h.

Public Types

enum  { kTextNDC = (1ULL << (14)) }
enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  { kTextNDC = (1ULL << (14)) }
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))
}

Public Member Functions

 TMathText ()
 Default constructor.
 TMathText (const TMathText &text)
 Copy constructor.
 TMathText (Double_t x, Double_t y, const char *text)
 Normal constructor.
 ~TMathText () override
 Destructor.
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
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.
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 (TAttFill &attfill) const
void Copy (TAttText &atttext) const
void Copy (TObject &text) const override
 Copy.
virtual void Delete (Option_t *option="")
 Delete this object.
Int_t DistancetoPrimitive (Int_t px, Int_t py) override
 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 with: gROOT->SetSelectedPad(c1).
TMathTextDrawMathText (Double_t x, Double_t y, const char *text)
 Make a copy of this object with the new parameters and copy object attributes.
virtual TTextDrawText (Double_t x, Double_t y, const char *text)
virtual TTextDrawText (Double_t x, Double_t y, const wchar_t *text)
virtual TTextDrawTextNDC (Double_t x, Double_t y, const char *text)
virtual TTextDrawTextNDC (Double_t x, Double_t y, const wchar_t *text)
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.
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to an event at (px,py).
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
Rectangle_t GetBBox () override
TPoint GetBBoxCenter () override
void GetBoundingBox (UInt_t &w, UInt_t &h, Bool_t angle=kFALSE) override
 Get the text width and height.
virtual void GetControlBox (Int_t x, Int_t y, Double_t theta, Int_t cBoxX[4], Int_t cBoxY[4])
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
virtual Color_t GetFillColor () const
 Return the fill area color.
virtual Style_t GetFillStyle () const
 Return the fill area style.
virtual const char * GetIconName () const
 Returns mime type name of object.
const char * GetName () const override
 Returns 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 void GetTextAdvance (UInt_t &a, const char *text, const Bool_t kern=kTRUE) const
virtual Short_t GetTextAlign () const
 Return the text alignment.
virtual Float_t GetTextAngle () const
 Return the text angle.
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const char *text) const
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const wchar_t *text) const
virtual Color_t GetTextColor () const
 Return the text color.
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const char *text) const
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const wchar_t *text) const
virtual Font_t GetTextFont () const
 Return the text font.
virtual Float_t GetTextSize () const
 Return the text size.
virtual Float_t GetTextSizePercent (Float_t size)
 Return the text in percent of the pad size.
virtual Float_t GetTextSizePixels (TVirtualPad &pad) const
 Return the text size in pixels for specified pad.
virtual Float_t GetTextSizeRelative (TVirtualPad &pad) const
 Return the text size in relative units.
const char * GetTitle () const override
 Returns title of object.
virtual UInt_t GetUniqueID () const
 Return the unique object id.
const void * GetWcsTitle (void) const
Double_t GetX () const
Double_t GetXsize ()
 Get X size.
Double_t GetY () const
Double_t GetYsize ()
 Get Y size.
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
ULong_t Hash () const override
 Return hash value for this object.
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)
TClassIsA () const override
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).
Bool_t IsOnHeap () const
Bool_t IsSortable () const override
virtual Bool_t IsTransparent () const
Bool_t IsZombie () const
void ls (Option_t *option="") const override
 List TNamed name and title.
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 void Modify ()
virtual void Modify ()
virtual void ModifyOn (TVirtualPad &pad)
virtual void ModifyOn (TVirtualPad &pad)
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 *, size_t)
 Operator delete for sized deallocation.
void operator delete (void *ptr)
 Operator delete.
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
void operator delete[] (void *, size_t)
 Operator delete [] for sized deallocation.
void operator delete[] (void *ptr)
 Operator delete [].
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
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)
void Paint (Option_t *option="") override
 Paint text.
virtual void PaintControlBox (Int_t x, Int_t y, Double_t theta)
virtual void PaintMathText (Double_t x, Double_t y, Double_t angle, Double_t size, const char *text)
 Paint text (used by Paint()).
virtual void PaintText (Double_t x, Double_t y, const char *text)
virtual void PaintText (Double_t x, Double_t y, const wchar_t *text)
virtual void PaintTextNDC (Double_t u, Double_t v, const char *text)
virtual void PaintTextNDC (Double_t u, Double_t v, const wchar_t *text)
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
void Print (Option_t *option="") const override
 Print TNamed name and title.
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.
virtual void ResetAttFill (Option_t *option="")
virtual void ResetAttText (Option_t *toption="")
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 SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save primitive as a C++ statement(s) on output stream out.
virtual void SaveTextAttributes (std::ostream &out, const char *name, Int_t alidef=12, Float_t angdef=0, Int_t coldef=1, Int_t fondef=61, Float_t sizdef=1)
void SetBBoxCenter (const TPoint &p) override
void SetBBoxCenterX (const Int_t x) override
void SetBBoxCenterY (const Int_t y) override
void SetBBoxX1 (const Int_t) override
void SetBBoxX2 (const Int_t) override
void SetBBoxY1 (const Int_t) override
void SetBBoxY2 (const Int_t) override
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 SetFillAttributes ()
virtual void SetFillColor (Color_t fcolor)
 Set the fill area color.
void SetFillColor (TColorNumber)
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style.
virtual void SetMbTitle (const wchar_t *title=L"")
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 SetNDC (Bool_t isNDC=kTRUE)
virtual void SetText (Double_t x, Double_t y, const char *text)
virtual void SetText (Double_t x, Double_t y, const wchar_t *text)
virtual void SetTextAlign (Short_t align=11)
 Set the text alignment.
virtual void SetTextAngle (Float_t tangle=0)
 Set the text angle.
virtual void SetTextAttributes ()
virtual void SetTextColor (Color_t tcolor=1)
 Set the text color.
void SetTextColor (TColorNumber lcolor)
virtual void SetTextColorAlpha (Color_t tcolor, Float_t talpha)
virtual void SetTextFont (Font_t tfont=62)
 Set the text font.
virtual void SetTextSize (Float_t tsize=1)
 Set the text size.
virtual void SetTextSizePixels (Int_t npixels)
 Set the text size in pixel.
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
virtual void SetX (Double_t x)
virtual void SetY (Double_t y)
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)
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
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 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

enum  { kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions

virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void GetAlignPoint (Double_t &x0, Double_t &y0, const Double_t size, const Double_t angle, const Char_t *t, const Int_t length, const Short_t align)
 Alignment.
void GetSize (Double_t &x0, Double_t &y0, Double_t &x1, Double_t &y1, const Double_t size, const Double_t angle, const Char_t *t, const Int_t length)
 Get the text bounding box.
Double_t GetXCoord (const Int_t x, Bool_t is_ndc=kFALSE)
Double_t GetYCoord (const Int_t y, Bool_t is_ndc=kFALSE)
void MakeZombie ()
TMathTextoperator= (const TMathText &)
 Assignment operator.
void Render (const Double_t x, const Double_t y, const Double_t size, const Double_t angle, const Char_t *t, const Int_t length)
 Render the text.
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".

Static Protected Member Functions

static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Protected Attributes

Color_t fFillColor
 Fill area color.
Style_t fFillStyle
 Fill area style.
TString fName
TMathTextRendererfRenderer {nullptr}
 !TMathText Painter
Short_t fTextAlign
 Text alignment.
Float_t fTextAngle
 Text angle.
Color_t fTextColor
 Text color.
Font_t fTextFont
 Text font.
Float_t fTextSize
 Text size.
TString fTitle
void * fWcsTitle {nullptr}
 !Used by TMathText
Double_t fX {0}
 X position of text (left,center,etc..).
Double_t fY {0}
 Y position of text (left,center,etc..).

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes

UInt_t fBits
 bit field status word
UInt_t fUniqueID
 object unique identifier

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable

Friends

class TMathTextRenderer

#include <TMathText.h>

Inheritance diagram for TMathText:
TText TAttFill TNamed TAttText TAttBBox2D TObject

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
kTextNDC 

The text position is in the NDC space.

Definition at line 31 of file TText.h.

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ anonymous enum

anonymous enum
Enumerator
kTextNDC 

Definition at line 39 of file TMathText.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TObject::EStatusBits
inherited
Enumerator
kCanDelete 

if object in a list can be deleted

kMustCleanup 

if object destructor must call RecursiveRemove()

kIsReferenced 

if object is referenced by a TRef or TRefArray

kHasUUID 

if object has a TUUID (its fUniqueID=UUIDNumber)

kCannotPick 

if object in a pad cannot be picked

kNoContextMenu 

if object does not want context menu

kInvalidObject 

if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ TMathText() [1/3]

TMathText::TMathText ( )

Default constructor.

Definition at line 321 of file TMathText.cxx.

◆ TMathText() [2/3]

TMathText::TMathText ( Double_t x,
Double_t y,
const char * text )

Normal constructor.

Definition at line 330 of file TMathText.cxx.

◆ TMathText() [3/3]

TMathText::TMathText ( const TMathText & text)

Copy constructor.

Definition at line 347 of file TMathText.cxx.

◆ ~TMathText()

TMathText::~TMathText ( )
override

Destructor.

Definition at line 339 of file TMathText.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 55 of file TMathText.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TNamed::Clear ( Option_t * option = "")
overridevirtualinherited

Set name and title to empty strings ("").

Reimplemented from TObject.

Reimplemented in TPrincipal, TProcessID, TStreamerInfo, TTask, TVirtualFitter, and TVirtualStreamerInfo.

Definition at line 63 of file TNamed.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "") const
overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj) const
overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ Copy() [1/3]

void TAttFill::Copy ( TAttFill & attfill) const
inherited

◆ Copy() [2/3]

void TAttText::Copy ( TAttText & atttext) const
inherited

◆ Copy() [3/3]

void TMathText::Copy ( TObject & text) const
overridevirtual

Copy.

Reimplemented from TObject.

Definition at line 370 of file TMathText.cxx.

◆ DeclFileName()

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

Definition at line 55 of file TMathText.h.

◆ Delete()

void TObject::Delete ( Option_t * option = "")
virtualinherited

◆ DistancetoPrimitive()

Int_t TText::DistancetoPrimitive ( Int_t px,
Int_t py )
overridevirtualinherited

Computes distance from point (px,py) to the object.

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented from TObject.

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ DrawMathText()

TMathText * TMathText::DrawMathText ( Double_t x,
Double_t y,
const char * text )

Make a copy of this object with the new parameters and copy object attributes.

Definition at line 517 of file TMathText.cxx.

◆ DrawText() [1/2]

virtual TText * TText::DrawText ( Double_t x,
Double_t y,
const char * text )
virtualinherited

◆ DrawText() [2/2]

virtual TText * TText::DrawText ( Double_t x,
Double_t y,
const wchar_t * text )
virtualinherited

◆ DrawTextNDC() [1/2]

virtual TText * TText::DrawTextNDC ( Double_t x,
Double_t y,
const char * text )
virtualinherited

◆ DrawTextNDC() [2/2]

virtual TText * TText::DrawTextNDC ( Double_t x,
Double_t y,
const wchar_t * text )
virtualinherited

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
Style_t fFillStyle
Fill area style.
Definition TAttFill.h:25
Color_t fFillColor
Fill area color.
Definition TAttFill.h:24
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

void TText::ExecuteEvent ( Int_t event,
Int_t px,
Int_t py )
overridevirtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented from TObject.

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ GetAlignPoint()

void TMathText::GetAlignPoint ( Double_t & x0,
Double_t & y0,
const Double_t size,
const Double_t angle,
const Char_t * t,
const Int_t length,
const Short_t align )
protected

Alignment.

Definition at line 420 of file TMathText.cxx.

◆ GetBBox()

Rectangle_t TText::GetBBox ( )
overridevirtualinherited

Implements TAttBBox2D.

◆ GetBBoxCenter()

TPoint TText::GetBBoxCenter ( )
overridevirtualinherited

Reimplemented from TAttBBox2D.

◆ GetBoundingBox()

void TMathText::GetBoundingBox ( UInt_t & w,
UInt_t & h,
Bool_t angle = kFALSE )
overridevirtual

Get the text width and height.

Reimplemented from TText.

Definition at line 453 of file TMathText.cxx.

◆ GetControlBox()

virtual void TText::GetControlBox ( Int_t x,
Int_t y,
Double_t theta,
Int_t cBoxX[4],
Int_t cBoxY[4] )
virtualinherited

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetFillColor()

virtual Color_t TAttFill::GetFillColor ( ) const
inlinevirtualinherited

Return the fill area color.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 32 of file TAttFill.h.

◆ GetFillStyle()

virtual Style_t TAttFill::GetFillStyle ( ) const
inlinevirtualinherited

Return the fill area style.

Reimplemented in TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, and TGX11.

Definition at line 33 of file TAttFill.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetSize()

void TMathText::GetSize ( Double_t & x0,
Double_t & y0,
Double_t & x1,
Double_t & y1,
const Double_t size,
const Double_t angle,
const Char_t * t,
const Int_t length )
protected

Get the text bounding box.

Definition at line 395 of file TMathText.cxx.

◆ GetTextAdvance()

virtual void TText::GetTextAdvance ( UInt_t & a,
const char * text,
const Bool_t kern = kTRUE ) const
virtualinherited

◆ GetTextAlign()

virtual Short_t TAttText::GetTextAlign ( ) const
inlinevirtualinherited

Return the text alignment.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 35 of file TAttText.h.

◆ GetTextAngle()

virtual Float_t TAttText::GetTextAngle ( ) const
inlinevirtualinherited

Return the text angle.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 36 of file TAttText.h.

◆ GetTextAscentDescent() [1/2]

virtual void TText::GetTextAscentDescent ( UInt_t & a,
UInt_t & d,
const char * text ) const
virtualinherited

◆ GetTextAscentDescent() [2/2]

virtual void TText::GetTextAscentDescent ( UInt_t & a,
UInt_t & d,
const wchar_t * text ) const
virtualinherited

◆ GetTextColor()

virtual Color_t TAttText::GetTextColor ( ) const
inlinevirtualinherited

Return the text color.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 37 of file TAttText.h.

◆ GetTextExtent() [1/2]

virtual void TText::GetTextExtent ( UInt_t & w,
UInt_t & h,
const char * text ) const
virtualinherited

◆ GetTextExtent() [2/2]

virtual void TText::GetTextExtent ( UInt_t & w,
UInt_t & h,
const wchar_t * text ) const
virtualinherited

◆ GetTextFont()

virtual Font_t TAttText::GetTextFont ( ) const
inlinevirtualinherited

Return the text font.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 38 of file TAttText.h.

◆ GetTextSize()

virtual Float_t TAttText::GetTextSize ( ) const
inlinevirtualinherited

Return the text size.

Reimplemented in TGWin32VirtualXProxy.

Definition at line 39 of file TAttText.h.

◆ GetTextSizePercent()

virtual Float_t TAttText::GetTextSizePercent ( Float_t size)
virtualinherited

Return the text in percent of the pad size.

◆ GetTextSizePixels()

virtual Float_t TAttText::GetTextSizePixels ( TVirtualPad & pad) const
virtualinherited

Return the text size in pixels for specified pad.

◆ GetTextSizeRelative()

virtual Float_t TAttText::GetTextSizeRelative ( TVirtualPad & pad) const
virtualinherited

Return the text size in relative units.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetWcsTitle()

const void * TText::GetWcsTitle ( void ) const
inherited

◆ GetX()

Double_t TText::GetX ( ) const
inlineinherited

Definition at line 53 of file TText.h.

◆ GetXCoord()

Double_t TAttBBox2D::GetXCoord ( const Int_t x,
Bool_t is_ndc = kFALSE )
protectedinherited

Definition at line 60 of file TAttBBox2D.cxx.

◆ GetXsize()

Double_t TMathText::GetXsize ( void )

Get X size.

Definition at line 474 of file TMathText.cxx.

◆ GetY()

Double_t TText::GetY ( ) const
inlineinherited

Definition at line 61 of file TText.h.

◆ GetYCoord()

Double_t TAttBBox2D::GetYCoord ( const Int_t y,
Bool_t is_ndc = kFALSE )
protectedinherited

Definition at line 76 of file TAttBBox2D.cxx.

◆ GetYsize()

Double_t TMathText::GetYsize ( void )

Get Y size.

Definition at line 495 of file TMathText.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 55 of file TMathText.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsTransparent()

Bool_t TAttFill::IsTransparent ( ) const
inlinevirtualinherited

Reimplemented in TGWin32VirtualXProxy.

Definition at line 49 of file TAttFill.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TText::ls ( Option_t * option = "") const
overridevirtualinherited

List TNamed name and title.

Reimplemented from TNamed.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

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).

Definition at line 1160 of file TObject.cxx.

◆ Modify() [1/2]

virtual void TAttFill::Modify ( )
virtualinherited

◆ Modify() [2/2]

virtual void TAttText::Modify ( )
virtualinherited

◆ ModifyOn() [1/2]

virtual void TAttFill::ModifyOn ( TVirtualPad & pad)
virtualinherited

◆ ModifyOn() [2/2]

virtual void TAttText::ModifyOn ( TVirtualPad & pad)
virtualinherited

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new ( size_t sz,
void * vp )
inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

void * TObject::operator new[] ( size_t sz,
void * vp )
inlineinherited

Definition at line 192 of file TObject.h.

◆ operator=()

TMathText & TMathText::operator= ( const TMathText & rhs)
protected

Assignment operator.

Definition at line 356 of file TMathText.cxx.

◆ Paint()

void TMathText::Paint ( Option_t * option = "")
overridevirtual

Paint text.

Reimplemented from TObject.

Definition at line 532 of file TMathText.cxx.

◆ PaintControlBox()

virtual void TText::PaintControlBox ( Int_t x,
Int_t y,
Double_t theta )
virtualinherited

◆ PaintMathText()

void TMathText::PaintMathText ( Double_t x,
Double_t y,
Double_t angle,
Double_t size,
const char * text )
virtual

Paint text (used by Paint()).

Definition at line 553 of file TMathText.cxx.

◆ PaintText() [1/2]

virtual void TText::PaintText ( Double_t x,
Double_t y,
const char * text )
virtualinherited

◆ PaintText() [2/2]

virtual void TText::PaintText ( Double_t x,
Double_t y,
const wchar_t * text )
virtualinherited

◆ PaintTextNDC() [1/2]

virtual void TText::PaintTextNDC ( Double_t u,
Double_t v,
const char * text )
virtualinherited

◆ PaintTextNDC() [2/2]

virtual void TText::PaintTextNDC ( Double_t u,
Double_t v,
const wchar_t * text )
virtualinherited

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TText::Print ( Option_t * option = "") const
overridevirtualinherited

Print TNamed name and title.

Reimplemented from TNamed.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ RecursiveRemove()

◆ Render()

void TMathText::Render ( const Double_t x,
const Double_t y,
const Double_t size,
const Double_t angle,
const Char_t * t,
const Int_t length )
protected

Render the text.

Definition at line 383 of file TMathText.cxx.

◆ ResetAttFill()

virtual void TAttFill::ResetAttFill ( Option_t * option = "")
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ ResetAttText()

virtual void TAttText::ResetAttText ( Option_t * toption = "")
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SaveFillAttributes()

virtual void TAttFill::SaveFillAttributes ( std::ostream & out,
const char * name,
Int_t coldef = 1,
Int_t stydef = 1001 )
virtualinherited

◆ SavePrimitive()

void TMathText::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
overridevirtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TObject.

Definition at line 645 of file TMathText.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SaveTextAttributes()

virtual void TAttText::SaveTextAttributes ( std::ostream & out,
const char * name,
Int_t alidef = 12,
Float_t angdef = 0,
Int_t coldef = 1,
Int_t fondef = 61,
Float_t sizdef = 1 )
virtualinherited

◆ SetBBoxCenter()

void TText::SetBBoxCenter ( const TPoint & p)
overridevirtualinherited

Reimplemented from TAttBBox2D.

◆ SetBBoxCenterX()

void TText::SetBBoxCenterX ( const Int_t x)
overridevirtualinherited

Implements TAttBBox2D.

◆ SetBBoxCenterY()

void TText::SetBBoxCenterY ( const Int_t y)
overridevirtualinherited

Implements TAttBBox2D.

◆ SetBBoxX1()

void TText::SetBBoxX1 ( const Int_t )
overridevirtualinherited

Implements TAttBBox2D.

◆ SetBBoxX2()

void TText::SetBBoxX2 ( const Int_t )
overridevirtualinherited

Implements TAttBBox2D.

◆ SetBBoxY1()

void TText::SetBBoxY1 ( const Int_t )
overridevirtualinherited

Implements TAttBBox2D.

◆ SetBBoxY2()

void TText::SetBBoxY2 ( const Int_t )
overridevirtualinherited

Implements TAttBBox2D.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetFillAttributes()

virtual void TAttFill::SetFillAttributes ( )
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ SetFillColor() [1/2]

virtual void TAttFill::SetFillColor ( Color_t fcolor)
inlinevirtualinherited

Set the fill area color.

Reimplemented in TGQuartz, TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSpider, TSVG, TTeXDump, and TVirtualX.

Definition at line 40 of file TAttFill.h.

◆ SetFillColor() [2/2]

void TAttFill::SetFillColor ( TColorNumber )
inherited

◆ SetFillColorAlpha()

virtual void TAttFill::SetFillColorAlpha ( Color_t fcolor,
Float_t falpha )
virtualinherited

Reimplemented in TGraphMultiErrors.

◆ SetFillStyle()

virtual void TAttFill::SetFillStyle ( Style_t fstyle)
inlinevirtualinherited

Set the fill area style.

Reimplemented in TGQuartz, TGraphMultiErrors, TGWin32, TGWin32VirtualXProxy, TGX11, TPad, TSpider, and TVirtualX.

Definition at line 42 of file TAttFill.h.

◆ SetMbTitle()

virtual void TText::SetMbTitle ( const wchar_t * title = L"")
virtualinherited

◆ SetName()

void TNamed::SetName ( const char * name)
virtualinherited

Set the name of the TNamed.

WARNING: if the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, ROOT::Experimental::XRooFit::xRooNode, TChain, TColor, TDirectory, TEfficiency, TEventList, TEveScene, TFormula, TGraph2D, TGraph, TH1, TNode, TRotMatrix, TShape, TSystemDirectory, TSystemFile, and TTree.

Definition at line 149 of file TNamed.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

◆ SetNDC()

virtual void TText::SetNDC ( Bool_t isNDC = kTRUE)
virtualinherited

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetText() [1/2]

virtual void TText::SetText ( Double_t x,
Double_t y,
const char * text )
inlinevirtualinherited

Definition at line 74 of file TText.h.

◆ SetText() [2/2]

virtual void TText::SetText ( Double_t x,
Double_t y,
const wchar_t * text )
inlinevirtualinherited

Definition at line 75 of file TText.h.

◆ SetTextAlign()

virtual void TAttText::SetTextAlign ( Short_t align = 11)
inlinevirtualinherited

Set the text alignment.

Reimplemented in TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, and TVirtualX.

Definition at line 48 of file TAttText.h.

◆ SetTextAngle()

virtual void TAttText::SetTextAngle ( Float_t tangle = 0)
inlinevirtualinherited

Set the text angle.

Reimplemented in TGraphNode, and TGWin32VirtualXProxy.

Definition at line 49 of file TAttText.h.

◆ SetTextAttributes()

virtual void TAttText::SetTextAttributes ( )
virtualinherited

Reimplemented in TGWin32VirtualXProxy.

◆ SetTextColor() [1/2]

virtual void TAttText::SetTextColor ( Color_t tcolor = 1)
inlinevirtualinherited

Set the text color.

Reimplemented in TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, TPDF, TPostScript, TSVG, TTeXDump, and TVirtualX.

Definition at line 50 of file TAttText.h.

◆ SetTextColor() [2/2]

void TAttText::SetTextColor ( TColorNumber lcolor)
inherited

◆ SetTextColorAlpha()

virtual void TAttText::SetTextColorAlpha ( Color_t tcolor,
Float_t talpha )
virtualinherited

◆ SetTextFont()

virtual void TAttText::SetTextFont ( Font_t tfont = 62)
inlinevirtualinherited

Set the text font.

Reimplemented in TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, and TVirtualX.

Definition at line 52 of file TAttText.h.

◆ SetTextSize()

virtual void TAttText::SetTextSize ( Float_t tsize = 1)
inlinevirtualinherited

Set the text size.

Reimplemented in TGQuartz, TGWin32, TGWin32VirtualXProxy, TGX11, and TVirtualX.

Definition at line 53 of file TAttText.h.

◆ SetTextSizePixels()

virtual void TAttText::SetTextSizePixels ( Int_t npixels)
virtualinherited

Set the text size in pixel.

Reimplemented in TGWin32VirtualXProxy.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetX()

virtual void TText::SetX ( Double_t x)
inlinevirtualinherited

Definition at line 76 of file TText.h.

◆ SetY()

virtual void TText::SetY ( Double_t y)
inlinevirtualinherited

Definition at line 77 of file TText.h.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void TMathText::Streamer ( TBuffer & R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMathText::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 55 of file TMathText.h.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

◆ TMathTextRenderer

friend class TMathTextRenderer
friend

Definition at line 22 of file TMathText.h.

Member Data Documentation

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fFillColor

Color_t TAttFill::fFillColor
protectedinherited

Fill area color.

Definition at line 24 of file TAttFill.h.

◆ fFillStyle

Style_t TAttFill::fFillStyle
protectedinherited

Fill area style.

Definition at line 25 of file TAttFill.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fRenderer

TMathTextRenderer* TMathText::fRenderer {nullptr}
protected

!TMathText Painter

Definition at line 24 of file TMathText.h.

◆ fTextAlign

Short_t TAttText::fTextAlign
protectedinherited

Text alignment.

Definition at line 26 of file TAttText.h.

◆ fTextAngle

Float_t TAttText::fTextAngle
protectedinherited

Text angle.

Definition at line 24 of file TAttText.h.

◆ fTextColor

Color_t TAttText::fTextColor
protectedinherited

Text color.

Definition at line 27 of file TAttText.h.

◆ fTextFont

Font_t TAttText::fTextFont
protectedinherited

Text font.

Definition at line 28 of file TAttText.h.

◆ fTextSize

Float_t TAttText::fTextSize
protectedinherited

Text size.

Definition at line 25 of file TAttText.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fWcsTitle

void* TText::fWcsTitle {nullptr}
protectedinherited

!Used by TMathText

Definition at line 27 of file TText.h.

◆ fX

Double_t TText::fX {0}
protectedinherited

X position of text (left,center,etc..).

Definition at line 25 of file TText.h.

◆ fY

Double_t TText::fY {0}
protectedinherited

Y position of text (left,center,etc..).

Definition at line 26 of file TText.h.


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