Logo ROOT   6.19/01
Reference Guide
TPolyLine Class Reference

Defined by an array on N points in a 2-D space.

One can draw the contour of the polyline or/and its fill area. Example:

{
Double_t x[5] = {.2,.7,.6,.25,.2};
Double_t y[5] = {.5,.1,.9,.7,.5};
pline->Draw("f");
pline->Draw();
}
pict1_TPolyLine_001.png

Definition at line 23 of file TPolyLine.h.

Public Types

enum  { kPolyLineNDC = BIT(14) }
 
- 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

 TPolyLine ()
 PolyLine default constructor. More...
 
 TPolyLine (Int_t n, Option_t *option="")
 PolyLine normal constructor without initialisation. More...
 
 TPolyLine (Int_t n, Float_t *x, Float_t *y, Option_t *option="")
 PolyLine normal constructor (single precision). More...
 
 TPolyLine (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 PolyLine normal constructor (double precision). More...
 
 TPolyLine (const TPolyLine &polyline)
 PolyLine copy constructor. More...
 
virtual ~TPolyLine ()
 PolyLine default destructor. More...
 
virtual void Copy (TObject &polyline) const
 Copy this polyline to polyline. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Returns closest distance in pixels from point (px, py) to a polyline. More...
 
virtual void Draw (Option_t *option="")
 Draw this polyline with its current attributes. More...
 
virtual void DrawPolyLine (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 Draw this polyline with new coordinates. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
virtual Int_t GetLastPoint () const
 
Int_t GetN () const
 
Option_tGetOption () const
 
Double_tGetX () const
 
Double_tGetY () const
 
virtual void ls (Option_t *option="") const
 List this polyline with its attributes. More...
 
virtual Int_t Merge (TCollection *list)
 Merge polylines in the collection in this polyline. More...
 
virtual void Paint (Option_t *option="")
 Paint this polyline with its current attributes. More...
 
virtual void PaintPolyLine (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 Draw this polyline with new coordinates. More...
 
virtual void PaintPolyLineNDC (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 Draw this polyline with new coordinates in NDC. More...
 
virtual void Print (Option_t *option="") const
 Dump this polyline 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 SetNDC (Bool_t isNDC=kTRUE)
 Set NDC mode on if isNDC = kTRUE, off otherwise. More...
 
virtual Int_t SetNextPoint (Double_t x, Double_t y)
 Set point following LastPoint to x, y. More...
 
virtual void SetOption (Option_t *option="")
 
virtual void SetPoint (Int_t point, Double_t x, Double_t y)
 Set point number n to (x, y) If n is greater than the current size, the arrays are automatically extended. More...
 
virtual void SetPolyLine (Int_t n)
 Resize this polyline to size n. More...
 
virtual void SetPolyLine (Int_t n, Float_t *x, Float_t *y, Option_t *option="")
 Set new values for this polyline (single precision). More...
 
virtual void SetPolyLine (Int_t n, Double_t *x, Double_t *y3, Option_t *option="")
 Set new values for this polyline (double precision). More...
 
virtual Int_t Size () const
 
- 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 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 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 TAttFill
 TAttFill ()
 AttFill default constructor. More...
 
 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
 Return the fill area color. More...
 
virtual Style_t GetFillStyle () const
 Return the fill area style. More...
 
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)
 Set the fill area color. More...
 
virtual void SetFillColorAlpha (Color_t fcolor, Float_t falpha)
 Set a transparent fill color. More...
 
virtual void SetFillStyle (Style_t fstyle)
 Set the fill area style. More...
 

Protected Member Functions

TPolyLineoperator= (const TPolyLine &)
 assignment operator 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 ()
 

Protected Attributes

Int_t fLastPoint
 The index of the last filled point. More...
 
Int_t fN
 Number of points. More...
 
TString fOption
 options More...
 
Double_tfX
 [fN] Array of X coordinates More...
 
Double_tfY
 [fN] Array of Y coordinates More...
 
- Protected Attributes inherited from TAttLine
Color_t fLineColor
 Line color. More...
 
Style_t fLineStyle
 Line style. More...
 
Width_t fLineWidth
 Line width. More...
 
- Protected Attributes inherited from TAttFill
Color_t fFillColor
 Fill area color. More...
 
Style_t fFillStyle
 Fill area style. 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...
 

#include <TPolyLine.h>

Inheritance diagram for TPolyLine:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kPolyLineNDC 

Polyline coordinates are in NDC space.

Definition at line 36 of file TPolyLine.h.

Constructor & Destructor Documentation

◆ TPolyLine() [1/5]

TPolyLine::TPolyLine ( )

PolyLine default constructor.

Definition at line 45 of file TPolyLine.cxx.

◆ TPolyLine() [2/5]

TPolyLine::TPolyLine ( Int_t  n,
Option_t option = "" 
)

PolyLine normal constructor without initialisation.

Allocates n points. The option string is ignored.

Definition at line 57 of file TPolyLine.cxx.

◆ TPolyLine() [3/5]

TPolyLine::TPolyLine ( Int_t  n,
Float_t x,
Float_t y,
Option_t option = "" 
)

PolyLine normal constructor (single precision).

Makes n points with (x, y) coordinates from x and y. The option string is ignored.

Definition at line 78 of file TPolyLine.cxx.

◆ TPolyLine() [4/5]

TPolyLine::TPolyLine ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)

PolyLine normal constructor (double precision).

Makes n points with (x, y) coordinates from x and y. The option string is ignored.

Definition at line 102 of file TPolyLine.cxx.

◆ TPolyLine() [5/5]

TPolyLine::TPolyLine ( const TPolyLine polyline)

PolyLine copy constructor.

Definition at line 151 of file TPolyLine.cxx.

◆ ~TPolyLine()

TPolyLine::~TPolyLine ( )
virtual

PolyLine default destructor.

Definition at line 142 of file TPolyLine.cxx.

Member Function Documentation

◆ Copy()

void TPolyLine::Copy ( TObject polyline) const
virtual

Copy this polyline to polyline.

Reimplemented from TObject.

Definition at line 163 of file TPolyLine.cxx.

◆ DistancetoPrimitive()

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

Returns closest distance in pixels from point (px, py) to a polyline.

First looks for distances to the points of the polyline. Stops search and returns if a vertex of the polyline is found to be closer than 10 pixels. Thus the return value may depend on the ordering of points in the polyline.

Then looks for distances to the lines of the polyline. There is no arbitrary cutoff; any distance may be found.

Finally checks whether (px, py) is inside a closed and filled polyline. (Must be EXACTLY closed. "Filled" means fill color and fill style are both non-zero.) If so, returns zero.

Returns 9999 if the polyline has no points.

Reimplemented from TObject.

Reimplemented in TCurlyLine, and TCurlyArc.

Definition at line 198 of file TPolyLine.cxx.

◆ Draw()

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

Draw this polyline with its current attributes.

Reimplemented from TObject.

Definition at line 232 of file TPolyLine.cxx.

◆ DrawPolyLine()

void TPolyLine::DrawPolyLine ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

Draw this polyline with new coordinates.

Definition at line 240 of file TPolyLine.cxx.

◆ ExecuteEvent()

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

Execute action corresponding to one event.

This member function is called when a polyline 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 TCurlyLine, and TCurlyArc.

Definition at line 261 of file TPolyLine.cxx.

◆ GetLastPoint()

virtual Int_t TPolyLine::GetLastPoint ( ) const
inlinevirtual

Definition at line 52 of file TPolyLine.h.

◆ GetN()

Int_t TPolyLine::GetN ( ) const
inline

Definition at line 53 of file TPolyLine.h.

◆ GetOption()

Option_t* TPolyLine::GetOption ( ) const
inlinevirtual

Reimplemented from TObject.

Definition at line 56 of file TPolyLine.h.

◆ GetX()

Double_t* TPolyLine::GetX ( ) const
inline

Definition at line 54 of file TPolyLine.h.

◆ GetY()

Double_t* TPolyLine::GetY ( ) const
inline

Definition at line 55 of file TPolyLine.h.

◆ ls()

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

List this polyline with its attributes.

The option string is ignored.

Reimplemented from TObject.

Definition at line 486 of file TPolyLine.cxx.

◆ Merge()

Int_t TPolyLine::Merge ( TCollection list)
virtual

Merge polylines in the collection in this polyline.

Definition at line 495 of file TPolyLine.cxx.

◆ operator=()

TPolyLine & TPolyLine::operator= ( const TPolyLine pl)
protected

assignment operator

Definition at line 124 of file TPolyLine.cxx.

◆ Paint()

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

Paint this polyline with its current attributes.

Reimplemented from TObject.

Definition at line 531 of file TPolyLine.cxx.

◆ PaintPolyLine()

void TPolyLine::PaintPolyLine ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

Draw this polyline with new coordinates.

If option = 'f' or 'F' the fill area is drawn. The default is to draw the lines only.

Definition at line 548 of file TPolyLine.cxx.

◆ PaintPolyLineNDC()

void TPolyLine::PaintPolyLineNDC ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

Draw this polyline with new coordinates in NDC.

Definition at line 572 of file TPolyLine.cxx.

◆ Print()

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

Dump this polyline with its attributes.

The option string is ignored.

Reimplemented from TObject.

Definition at line 584 of file TPolyLine.cxx.

◆ SavePrimitive()

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

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

Reimplemented from TObject.

Reimplemented in TCurlyLine, and TCurlyArc.

Definition at line 592 of file TPolyLine.cxx.

◆ SetNDC()

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

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

Definition at line 617 of file TPolyLine.cxx.

◆ SetNextPoint()

Int_t TPolyLine::SetNextPoint ( Double_t  x,
Double_t  y 
)
virtual

Set point following LastPoint to x, y.

Returns index of the point (new last point).

Definition at line 627 of file TPolyLine.cxx.

◆ SetOption()

virtual void TPolyLine::SetOption ( Option_t option = "")
inlinevirtual

Definition at line 66 of file TPolyLine.h.

◆ SetPoint()

void TPolyLine::SetPoint ( Int_t  n,
Double_t  x,
Double_t  y 
)
virtual

Set point number n to (x, y) If n is greater than the current size, the arrays are automatically extended.

Definition at line 639 of file TPolyLine.cxx.

◆ SetPolyLine() [1/3]

void TPolyLine::SetPolyLine ( Int_t  n)
virtual

Resize this polyline to size n.

If n <= 0 the current arrays of points are deleted. If n is greater than the current size, the new points are set to (0, 0)

Definition at line 671 of file TPolyLine.cxx.

◆ SetPolyLine() [2/3]

void TPolyLine::SetPolyLine ( Int_t  n,
Float_t x,
Float_t y,
Option_t option = "" 
)
virtual

Set new values for this polyline (single precision).

If n <= 0 the current arrays of points are deleted.

Definition at line 694 of file TPolyLine.cxx.

◆ SetPolyLine() [3/3]

void TPolyLine::SetPolyLine ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

Set new values for this polyline (double precision).

If n <= 0 the current arrays of points are deleted.

Definition at line 722 of file TPolyLine.cxx.

◆ Size()

virtual Int_t TPolyLine::Size ( ) const
inlinevirtual

Definition at line 71 of file TPolyLine.h.

Member Data Documentation

◆ fLastPoint

Int_t TPolyLine::fLastPoint
protected

The index of the last filled point.

Definition at line 27 of file TPolyLine.h.

◆ fN

Int_t TPolyLine::fN
protected

Number of points.

Definition at line 26 of file TPolyLine.h.

◆ fOption

TString TPolyLine::fOption
protected

options

Definition at line 30 of file TPolyLine.h.

◆ fX

Double_t* TPolyLine::fX
protected

[fN] Array of X coordinates

Definition at line 28 of file TPolyLine.h.

◆ fY

Double_t* TPolyLine::fY
protected

[fN] Array of Y coordinates

Definition at line 29 of file TPolyLine.h.

Libraries for TPolyLine:
[legend]

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