Logo ROOT   6.19/01
Reference Guide
TLine Class Reference

A simple line.

Definition at line 23 of file TLine.h.

Public Types

enum  { kLineNDC = BIT(14), kVertical = BIT(15), kHorizontal = BIT(16) }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TLine ()
 
 TLine (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Line normal constructor. More...
 
 TLine (const TLine &line)
 Line copy constructor. More...
 
virtual ~TLine ()=default
 
void Copy (TObject &line) const
 Copy this line to line. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to a line. More...
 
virtual TLineDrawLine (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw this line with new coordinates. More...
 
virtual TLineDrawLineNDC (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw this line 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 Rectangle_t GetBBox ()
 Return the bounding Box of the Line. More...
 
virtual TPoint GetBBoxCenter ()
 Return the center of the BoundingBox as TPoint in pixels. More...
 
Double_t GetX1 () const
 
Double_t GetX2 () const
 
Double_t GetY1 () const
 
Double_t GetY2 () const
 
Bool_t IsHorizontal ()
 Check whether this line is to be drawn horizontally. More...
 
Bool_t IsVertical ()
 Check whether this line is to be drawn vertically. More...
 
virtual void ls (Option_t *option="") const
 List this line with its attributes. More...
 
TLineoperator= (const TLine &src)
 Assignment operator. More...
 
virtual void Paint (Option_t *option="")
 Paint this line with its current attributes. More...
 
virtual void PaintLine (Double_t x1, Double_t y1, Double_t x2, Double_t y2)
 Draw this line with new coordinates. More...
 
virtual void PaintLineNDC (Double_t u1, Double_t v1, Double_t u2, Double_t v2)
 Draw this line with new coordinates in NDC. More...
 
virtual void Print (Option_t *option="") const
 Dump this line with its attributes. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
virtual void SetBBoxCenter (const TPoint &p)
 Set center of the BoundingBox. More...
 
virtual void SetBBoxCenterX (const Int_t x)
 Set X coordinate of the center of the BoundingBox. More...
 
virtual void SetBBoxCenterY (const Int_t y)
 Set Y coordinate of the center of the BoundingBox. 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...
 
void SetHorizontal (Bool_t set=kTRUE)
 Force the line to be drawn horizontally. More...
 
virtual void SetNDC (Bool_t isNDC=kTRUE)
 Set NDC mode on if isNDC = kTRUE, off otherwise. More...
 
void SetVertical (Bool_t set=kTRUE)
 Force the line to be drawn vertically. More...
 
virtual void SetX1 (Double_t x1)
 
virtual void SetX2 (Double_t x2)
 
virtual void SetY1 (Double_t y1)
 
virtual void SetY2 (Double_t y2)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
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 abstract method. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. 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)
 
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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 
- Public Member Functions inherited from TAttLine
 TAttLine ()
 AttLine default constructor. More...
 
 TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
 AttLine normal constructor. More...
 
virtual ~TAttLine ()
 AttLine destructor. More...
 
void Copy (TAttLine &attline) const
 Copy this line attributes to a new TAttLine. More...
 
Int_t DistancetoLine (Int_t px, Int_t py, Double_t xp1, Double_t yp1, Double_t xp2, Double_t yp2)
 Compute distance from point px,py to a line. More...
 
virtual Color_t GetLineColor () const
 Return the line color. More...
 
virtual Style_t GetLineStyle () const
 Return the line style. More...
 
virtual Width_t GetLineWidth () const
 Return the line width. More...
 
virtual void Modify ()
 Change current line attributes if necessary. More...
 
virtual void ResetAttLine (Option_t *option="")
 Reset this line attributes to default values. More...
 
virtual void SaveLineAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t widdef=1)
 Save line attributes as C++ statement(s) on output stream out. More...
 
virtual void SetLineAttributes ()
 Invoke the DialogCanvas Line attributes. More...
 
virtual void SetLineColor (Color_t lcolor)
 Set the line color. More...
 
virtual void SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
 Set a transparent line color. More...
 
virtual void SetLineStyle (Style_t lstyle)
 Set the line style. More...
 
virtual void SetLineWidth (Width_t lwidth)
 Set the line width. More...
 
- Public Member Functions inherited from TAttBBox2D
virtual ~TAttBBox2D ()
 

Protected Attributes

Double_t fX1 {0}
 X of 1st point. More...
 
Double_t fX2 {0}
 X of 2nd point. More...
 
Double_t fY1 {0}
 Y of 1st point. More...
 
Double_t fY2 {0}
 Y of 2nd point. More...
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color. More...
 
Style_t fLineStyle
 Line style. More...
 
Width_t fLineWidth
 Line width. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TLine.h>

Inheritance diagram for TLine:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kLineNDC 

Use NDC coordinates.

kVertical 

Line is vertical.

kHorizontal 

Line is horizontal.

Definition at line 33 of file TLine.h.

Constructor & Destructor Documentation

◆ TLine() [1/3]

TLine::TLine ( )
inline

Definition at line 39 of file TLine.h.

◆ TLine() [2/3]

TLine::TLine ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)

Line normal constructor.

Definition at line 35 of file TLine.cxx.

◆ TLine() [3/3]

TLine::TLine ( const TLine line)

Line copy constructor.

Definition at line 45 of file TLine.cxx.

◆ ~TLine()

virtual TLine::~TLine ( )
virtualdefault

Member Function Documentation

◆ Copy()

void TLine::Copy ( TObject line) const
virtual

Copy this line to line.

Reimplemented from TObject.

Definition at line 62 of file TLine.cxx.

◆ DistancetoPrimitive()

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

Compute distance from point px,py to a line.

Reimplemented from TObject.

Definition at line 75 of file TLine.cxx.

◆ DrawLine()

TLine * TLine::DrawLine ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)
virtual

Draw this line with new coordinates.

Definition at line 88 of file TLine.cxx.

◆ DrawLineNDC()

TLine * TLine::DrawLineNDC ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)
virtual

Draw this line with new coordinates in NDC.

Definition at line 100 of file TLine.cxx.

◆ ExecuteEvent()

void TLine::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
virtual

Execute action corresponding to one event.

This member function is called when a line is clicked with the locator

If Left button clicked on one of the line end points, this point follows the cursor until button is released.

if Middle button clicked, the line is moved parallel to itself until the button is released.

Reimplemented from TObject.

Reimplemented in TASPaletteEditor::LimitLine.

Definition at line 117 of file TLine.cxx.

◆ GetBBox()

Rectangle_t TLine::GetBBox ( )
virtual

Return the bounding Box of the Line.

Implements TAttBBox2D.

Definition at line 526 of file TLine.cxx.

◆ GetBBoxCenter()

TPoint TLine::GetBBoxCenter ( )
virtual

Return the center of the BoundingBox as TPoint in pixels.

Implements TAttBBox2D.

Definition at line 550 of file TLine.cxx.

◆ GetX1()

Double_t TLine::GetX1 ( ) const
inline

Definition at line 51 of file TLine.h.

◆ GetX2()

Double_t TLine::GetX2 ( ) const
inline

Definition at line 52 of file TLine.h.

◆ GetY1()

Double_t TLine::GetY1 ( ) const
inline

Definition at line 53 of file TLine.h.

◆ GetY2()

Double_t TLine::GetY2 ( ) const
inline

Definition at line 54 of file TLine.h.

◆ IsHorizontal()

Bool_t TLine::IsHorizontal ( )

Check whether this line is to be drawn horizontally.

Definition at line 433 of file TLine.cxx.

◆ IsVertical()

Bool_t TLine::IsVertical ( )

Check whether this line is to be drawn vertically.

Definition at line 441 of file TLine.cxx.

◆ ls()

void TLine::ls ( Option_t option = "") const
virtual

List this line with its attributes.

Reimplemented from TObject.

Definition at line 365 of file TLine.cxx.

◆ operator=()

TLine & TLine::operator= ( const TLine src)

Assignment operator.

Definition at line 53 of file TLine.cxx.

◆ Paint()

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

Paint this line with its current attributes.

Reimplemented from TObject.

Reimplemented in TGaxis, TASPaletteEditor::LimitLine, and TArrow.

Definition at line 374 of file TLine.cxx.

◆ PaintLine()

void TLine::PaintLine ( Double_t  x1,
Double_t  y1,
Double_t  x2,
Double_t  y2 
)
virtual

Draw this line with new coordinates.

Definition at line 383 of file TLine.cxx.

◆ PaintLineNDC()

void TLine::PaintLineNDC ( Double_t  u1,
Double_t  v1,
Double_t  u2,
Double_t  v2 
)
virtual

Draw this line with new coordinates in NDC.

Definition at line 392 of file TLine.cxx.

◆ Print()

void TLine::Print ( Option_t option = "") const
virtual

Dump this line with its attributes.

Reimplemented from TObject.

Definition at line 401 of file TLine.cxx.

◆ SavePrimitive()

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

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

Reimplemented from TObject.

Reimplemented in TGaxis, and TArrow.

Definition at line 413 of file TLine.cxx.

◆ SetBBoxCenter()

void TLine::SetBBoxCenter ( const TPoint p)
virtual

Set center of the BoundingBox.

Implements TAttBBox2D.

Definition at line 561 of file TLine.cxx.

◆ SetBBoxCenterX()

void TLine::SetBBoxCenterX ( const Int_t  x)
virtual

Set X coordinate of the center of the BoundingBox.

Implements TAttBBox2D.

Definition at line 586 of file TLine.cxx.

◆ SetBBoxCenterY()

void TLine::SetBBoxCenterY ( const Int_t  y)
virtual

Set Y coordinate of the center of the BoundingBox.

Implements TAttBBox2D.

Definition at line 602 of file TLine.cxx.

◆ SetBBoxX1()

void TLine::SetBBoxX1 ( const Int_t  x)
virtual

Set left hand side of BoundingBox to a value (resize in x direction on left)

Implements TAttBBox2D.

Definition at line 619 of file TLine.cxx.

◆ SetBBoxX2()

void TLine::SetBBoxX2 ( const Int_t  x)
virtual

Set right hand side of BoundingBox to a value (resize in x direction on right)

Implements TAttBBox2D.

Definition at line 631 of file TLine.cxx.

◆ SetBBoxY1()

void TLine::SetBBoxY1 ( const Int_t  y)
virtual

Set top of BoundingBox to a value (resize in y direction on top)

Implements TAttBBox2D.

Definition at line 642 of file TLine.cxx.

◆ SetBBoxY2()

void TLine::SetBBoxY2 ( const Int_t  y)
virtual

Set bottom of BoundingBox to a value (resize in y direction on bottom)

Implements TAttBBox2D.

Definition at line 654 of file TLine.cxx.

◆ SetHorizontal()

void TLine::SetHorizontal ( Bool_t  set = kTRUE)

Force the line to be drawn horizontally.

Makes fY2 equal to fY1. The line length is kept. TArrow and TGaxis also get this function by inheritance.

Definition at line 460 of file TLine.cxx.

◆ SetNDC()

void TLine::SetNDC ( Bool_t  isNDC = kTRUE)
virtual

Set NDC mode on if isNDC = kTRUE, off otherwise.

Definition at line 449 of file TLine.cxx.

◆ SetVertical()

void TLine::SetVertical ( Bool_t  set = kTRUE)

Force the line to be drawn vertically.

Makes fX2 equal to fX1. The line length is kept. TArrow and TGaxis also get this function by inheritance.

Definition at line 481 of file TLine.cxx.

◆ SetX1()

virtual void TLine::SetX1 ( Double_t  x1)
inlinevirtual

Definition at line 66 of file TLine.h.

◆ SetX2()

virtual void TLine::SetX2 ( Double_t  x2)
inlinevirtual

Definition at line 67 of file TLine.h.

◆ SetY1()

virtual void TLine::SetY1 ( Double_t  y1)
inlinevirtual

Definition at line 68 of file TLine.h.

◆ SetY2()

virtual void TLine::SetY2 ( Double_t  y2)
inlinevirtual

Definition at line 69 of file TLine.h.

Member Data Documentation

◆ fX1

Double_t TLine::fX1 {0}
protected

X of 1st point.

Definition at line 26 of file TLine.h.

◆ fX2

Double_t TLine::fX2 {0}
protected

X of 2nd point.

Definition at line 28 of file TLine.h.

◆ fY1

Double_t TLine::fY1 {0}
protected

Y of 1st point.

Definition at line 27 of file TLine.h.

◆ fY2

Double_t TLine::fY2 {0}
protected

Y of 2nd point.

Definition at line 29 of file TLine.h.

Libraries for TLine:
[legend]

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