ROOT  6.06/09
Reference Guide
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
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:

// This macro draws various formula in a canvas and prints the canvas
// as a Postscript file using TMathText.
//Author: Yue Shi Lai
{
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.gif");
c1->Print("c1.jpg");
c1->Print("c1.png");
c1->Print("c1.ps");
c1->Print("c1.eps");
return c1;
}
TMathText_001.png

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

TMathText_002.png

Definition at line 26 of file TMathText.h.

Public Types

enum  { kTextNDC = BIT(14) }
 
- Public Types inherited from TText
enum  { kTextNDC = BIT(14) }
 Used by TMathText. More...
 
- 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) }
 

Public Member Functions

 TMathText (void)
 
 TMathText (Double_t x, Double_t y, const char *text)
 Normal constructor. More...
 
 TMathText (const TMathText &text)
 Copy constructor. More...
 
virtual ~TMathText (void)
 Destructor. More...
 
void Copy (TObject &text) const
 Copy. More...
 
TMathTextDrawMathText (Double_t x, Double_t y, const char *text)
 Make a copy of this object with the new parameters and copy object attributes. More...
 
void GetBoundingBox (UInt_t &w, UInt_t &h, Bool_t angle=kFALSE)
 Get the text width and height. More...
 
Double_t GetXsize (void)
 Get X size. More...
 
Double_t GetYsize (void)
 Get Y size. More...
 
virtual void Paint (Option_t *option="")
 Paint text. More...
 
virtual void PaintMathText (Double_t x, Double_t y, Double_t angle, Double_t size, const char *text)
 Paint text (used by Paint()). More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
- Public Member Functions inherited from TText
 TText ()
 
 TText (Double_t x, Double_t y, const char *text)
 Text normal constructor. More...
 
 TText (Double_t x, Double_t y, const wchar_t *text)
 Text normal constructor. More...
 
 TText (const TText &text)
 Copy constructor. More...
 
virtual ~TText ()
 Text default destructor. More...
 
void Copy (TObject &text) const
 Copy this text to text. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to a string. More...
 
virtual TTextDrawText (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates. More...
 
virtual TTextDrawText (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates. More...
 
virtual TTextDrawTextNDC (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates in NDC. More...
 
virtual TTextDrawTextNDC (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates in NDC. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
virtual void GetControlBox (Int_t x, Int_t y, Double_t theta, Int_t cBoxX[4], Int_t cBoxY[4])
 Return the text control box. More...
 
Double_t GetX () const
 
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const char *text) const
 Return text ascent and descent for string text. More...
 
virtual void GetTextAscentDescent (UInt_t &a, UInt_t &d, const wchar_t *text) const
 Return text ascent and descent for string text. More...
 
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const char *text) const
 Return text extent for string text. More...
 
virtual void GetTextExtent (UInt_t &w, UInt_t &h, const wchar_t *text) const
 Return text extent for string text. More...
 
virtual void GetTextAdvance (UInt_t &a, const char *text, const Bool_t kern=kTRUE) const
 Return text advance for string text if kern is true (default) kerning is taken into account. More...
 
const voidGetWcsTitle (void) const
 Returns the text as UNICODE. More...
 
Double_t GetY () const
 
virtual void ls (Option_t *option="") const
 List this text with its attributes. More...
 
virtual void PaintControlBox (Int_t x, Int_t y, Double_t theta)
 Paint the text control box. More...
 
virtual void PaintText (Double_t x, Double_t y, const char *text)
 Draw this text with new coordinates. More...
 
virtual void PaintText (Double_t x, Double_t y, const wchar_t *text)
 Draw this text with new coordinates. More...
 
virtual void PaintTextNDC (Double_t u, Double_t v, const char *text)
 Draw this text with new coordinates in NDC. More...
 
virtual void PaintTextNDC (Double_t u, Double_t v, const wchar_t *text)
 Draw this text with new coordinates in NDC. More...
 
virtual void Print (Option_t *option="") const
 Dump this text with its attributes. More...
 
virtual void SetMbTitle (const wchar_t *title=L"")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void SetNDC (Bool_t isNDC=kTRUE)
 Set NDC mode on if isNDC = kTRUE, off otherwise. More...
 
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 SetX (Double_t x)
 
virtual void SetY (Double_t y)
 
virtual Rectangle_t GetBBox ()
 Return the "bounding Box" of the Box. More...
 
virtual TPoint GetBBoxCenter ()
 Return the point given by Alignment as 'center'. More...
 
virtual void SetBBoxCenter (const TPoint &p)
 Set the point given by Alignment as 'center'. More...
 
virtual void SetBBoxCenterX (const Int_t x)
 Set X coordinate of the point given by Alignment as 'center'. More...
 
virtual void SetBBoxCenterY (const Int_t y)
 Set Y coordinate of the point given by Alignment as 'center'. More...
 
virtual void SetBBoxX1 (const Int_t x)
 Set left hand side of BoundingBox to a value (resize in x direction on left) More...
 
virtual void SetBBoxX2 (const Int_t x)
 Set right hand side of BoundingBox to a value (resize in x direction on right) More...
 
virtual void SetBBoxY1 (const Int_t y)
 Set top of BoundingBox to a value (resize in y direction on top) More...
 
virtual void SetBBoxY2 (const Int_t y)
 Set bottom of BoundingBox to a value (resize in y direction on bottom) 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 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 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 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 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...
 
- Public Member Functions inherited from TAttText
 TAttText ()
 
 TAttText (Int_t align, Float_t angle, Color_t color, Style_t font, Float_t tsize)
 AttText normal constructor. More...
 
virtual ~TAttText ()
 AttText destructor. More...
 
void Copy (TAttText &atttext) const
 Copy this text attributes to a new TAttText. More...
 
virtual Short_t GetTextAlign () const
 
virtual Float_t GetTextAngle () const
 
virtual Color_t GetTextColor () const
 
virtual Font_t GetTextFont () const
 
virtual Float_t GetTextSize () const
 
virtual void Modify ()
 Change current text attributes if necessary. More...
 
virtual void ResetAttText (Option_t *toption="")
 Reset this text attributes to default values. More...
 
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)
 Save text attributes as C++ statement(s) on output stream out. More...
 
virtual void SetTextAttributes ()
 Invoke the DialogCanvas Text attributes. More...
 
virtual void SetTextAlign (Short_t align=11)
 
virtual void SetTextAngle (Float_t tangle=0)
 
virtual void SetTextColor (Color_t tcolor=1)
 
virtual void SetTextColorAlpha (Color_t tcolor, Float_t talpha)
 Set a transparent marker color. More...
 
virtual void SetTextFont (Font_t tfont=62)
 
virtual void SetTextSize (Float_t tsize=1)
 
virtual void SetTextSizePixels (Int_t npixels)
 Set the text size in pixels. More...
 
- Public Member Functions inherited from TAttBBox2D
virtual ~TAttBBox2D ()
 
 ClassDef (TAttBBox2D, 0)
 
- Public Member Functions inherited from TAttFill
 TAttFill ()
 
 TAttFill (Color_t fcolor, Style_t fstyle)
 AttFill normal constructor. More...
 
virtual ~TAttFill ()
 AttFill destructor. More...
 
void Copy (TAttFill &attfill) const
 Copy this fill attributes to a new TAttFill. More...
 
virtual Color_t GetFillColor () const
 
virtual Style_t GetFillStyle () const
 
virtual Bool_t IsTransparent () const
 
virtual void Modify ()
 Change current fill area attributes if necessary. More...
 
virtual void ResetAttFill (Option_t *option="")
 Reset this fill attributes to default values. More...
 
virtual void SaveFillAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1001)
 Save fill attributes as C++ statement(s) on output stream out. More...
 
virtual void SetFillAttributes ()
 Invoke the DialogCanvas Fill attributes. More...
 
virtual void SetFillColor (Color_t fcolor)
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 

Protected Member Functions

TMathTextoperator= (const TMathText &)
 TMathText Painter. More...
 
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. More...
 
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. More...
 
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. 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

voidfRenderer
 
- Protected Attributes inherited from TText
Double_t fX
 
Double_t fY
 
voidfWcsTitle
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TAttText
Float_t fTextAngle
 
Float_t fTextSize
 
Short_t fTextAlign
 
Color_t fTextColor
 
Font_t fTextFont
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 
Style_t fFillStyle
 

Friends

class TMathTextRenderer
 

Additional Inherited Members

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

#include <TMathText.h>

+ Inheritance diagram for TMathText:
+ Collaboration diagram for TMathText:

Member Enumeration Documentation

anonymous enum
Enumerator
kTextNDC 

Definition at line 43 of file TMathText.h.

Constructor & Destructor Documentation

TMathText::TMathText ( void  )

Referenced by DrawMathText().

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

Normal constructor.

Definition at line 354 of file TMathText.cxx.

TMathText::TMathText ( const TMathText text)

Copy constructor.

Definition at line 370 of file TMathText.cxx.

TMathText::~TMathText ( void  )
virtual

Destructor.

Definition at line 363 of file TMathText.cxx.

Member Function Documentation

void TMathText::Copy ( TObject text) const
virtual

Copy.

Reimplemented from TNamed.

Definition at line 392 of file TMathText.cxx.

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 549 of file TMathText.cxx.

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 450 of file TMathText.cxx.

Referenced by PaintMathText().

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

Get the text width and height.

Reimplemented from TText.

Definition at line 486 of file TMathText.cxx.

Referenced by TLatex::GetBoundingBox().

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 417 of file TMathText.cxx.

Referenced by GetBoundingBox(), GetXsize(), and GetYsize().

Double_t TMathText::GetXsize ( void  )

Get X size.

Definition at line 506 of file TMathText.cxx.

Referenced by TLatex::GetXsize().

Double_t TMathText::GetYsize ( void  )

Get Y size.

Definition at line 527 of file TMathText.cxx.

Referenced by TLatex::GetYsize().

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

TMathText Painter.

Assignment operator.

Definition at line 380 of file TMathText.cxx.

void TMathText::Paint ( Option_t option = "")
virtual

Paint text.

Reimplemented from TText.

Definition at line 564 of file TMathText.cxx.

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 584 of file TMathText.cxx.

Referenced by Paint(), and TLatex::PaintLatex1().

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 403 of file TMathText.cxx.

Referenced by PaintMathText().

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

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

Reimplemented from TText.

Definition at line 676 of file TMathText.cxx.

Friends And Related Function Documentation

friend class TMathTextRenderer
friend

Definition at line 64 of file TMathText.h.

Referenced by GetAlignPoint(), GetSize(), Render(), and TMathText().

Member Data Documentation

void* TMathText::fRenderer
protected

Definition at line 28 of file TMathText.h.

Referenced by Copy(), GetAlignPoint(), GetSize(), Render(), and TMathText().


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