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

A PolyMarker is defined by an array on N points in a 2-D space.

At each point x[i], y[i] a marker is drawn. Marker attributes are managed by TAttMarker. See TMarker for the list of possible marker types.

Definition at line 31 of file TPolyMarker.h.

Public Member Functions

 TPolyMarker ()
 Default constructor.
 
 TPolyMarker (const TPolyMarker &polymarker)
 Copy constructor.
 
 TPolyMarker (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 Constructor.
 
 TPolyMarker (Int_t n, Float_t *x, Float_t *y, Option_t *option="")
 Constructor.
 
 TPolyMarker (Int_t n, Option_t *option="")
 Constructor.
 
 ~TPolyMarker () override
 Destructor.
 
void Copy (TObject &polymarker) const override
 Copy this to obj.
 
Int_t DistancetoPrimitive (Int_t px, Int_t py) override
 Compute distance from point px,py to a polymarker.
 
void Draw (Option_t *option="") override
 Draw.
 
virtual void DrawPolyMarker (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 Draw polymarker.
 
void ExecuteEvent (Int_t event, Int_t px, Int_t py) override
 Execute action corresponding to one event.
 
virtual Int_t GetLastPoint () const
 Get the index of the last filled point.
 
virtual Int_t GetN () const
 Get the current capacity (reserved size) of the TPolyMarker.
 
Option_tGetOption () const override
 
Double_tGetX () const
 
Double_tGetY () const
 
TClassIsA () const override
 
void ls (Option_t *option="") const override
 ls.
 
virtual Int_t Merge (TCollection *list)
 Merge polymarkers in the collection in this polymarker.
 
void Paint (Option_t *option="") override
 Paint.
 
virtual void PaintPolyMarker (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 Paint polymarker.
 
void Print (Option_t *option="") const override
 Print polymarker.
 
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save primitive as a C++ statement(s) on output stream out.
 
virtual Int_t SetNextPoint (Double_t x, Double_t y)
 Set point following LastPoint to x, y.
 
virtual void SetPoint (Int_t point, Double_t x, Double_t y)
 Set point number n.
 
virtual void SetPolyMarker (Int_t n)
 If n <= 0 the current arrays of points are deleted.
 
virtual void SetPolyMarker (Int_t n, Double_t *x, Double_t *y, Option_t *option="")
 If n <= 0 the current arrays of points are deleted.
 
virtual void SetPolyMarker (Int_t n, Float_t *x, Float_t *y, Option_t *option="")
 If n <= 0 the current arrays of points are deleted.
 
virtual Int_t Size () const
 
void Streamer (TBuffer &) override
 Stream a class object.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
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.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
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).
 
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.
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 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 const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 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)
 
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).
 
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).
 
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 *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
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)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
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.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
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 SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
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.
 
- Public Member Functions inherited from TAttMarker
 TAttMarker ()
 TAttMarker default constructor.
 
 TAttMarker (Color_t color, Style_t style, Size_t msize)
 TAttMarker normal constructor.
 
virtual ~TAttMarker ()
 TAttMarker destructor.
 
void Copy (TAttMarker &attmarker) const
 Copy this marker attributes to a new TAttMarker.
 
virtual Color_t GetMarkerColor () const
 Return the marker color.
 
virtual Size_t GetMarkerSize () const
 Return the marker size.
 
virtual Style_t GetMarkerStyle () const
 Return the marker style.
 
virtual void Modify ()
 Change current marker attributes if necessary.
 
virtual void ResetAttMarker (Option_t *toption="")
 Reset this marker attributes to the default values.
 
virtual void SaveMarkerAttributes (std::ostream &out, const char *name, Int_t coldef=1, Int_t stydef=1, Int_t sizdef=1)
 Save line attributes as C++ statement(s) on output stream out.
 
virtual void SetMarkerAttributes ()
 Invoke the DialogCanvas Marker attributes.
 
virtual void SetMarkerColor (Color_t mcolor=1)
 Set the marker color.
 
virtual void SetMarkerColorAlpha (Color_t mcolor, Float_t malpha)
 Set a transparent marker color.
 
virtual void SetMarkerSize (Size_t msize=1)
 Set the marker size.
 
virtual void SetMarkerStyle (Style_t mstyle=1)
 Set the marker style.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
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.
 
- Static Public Member Functions inherited from TAttMarker
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Width_t GetMarkerLineWidth (Style_t style)
 Internal helper function that returns the line width of the given marker style (0 = filled marker)
 
static Style_t GetMarkerStyleBase (Style_t style)
 Internal helper function that returns the corresponding marker style with line width 1 for the given style.
 

Protected Member Functions

TPolyMarkeroperator= (const TPolyMarker &)
 assignment operator
 
- 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).
 
void MakeZombie ()
 

Protected Attributes

Int_t fLastPoint {-1}
 The index of the last filled point.
 
Int_t fN {0}
 Number of points internally reserved (not necessarily used)
 
TString fOption
 Options.
 
Double_tfX {nullptr}
 [fN] Array of X coordinates
 
Double_tfY {nullptr}
 [fN] Array of Y coordinates
 
- Protected Attributes inherited from TAttMarker
Color_t fMarkerColor
 Marker color.
 
Size_t fMarkerSize
 Marker size.
 
Style_t fMarkerStyle
 Marker style.
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
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 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

#include <TPolyMarker.h>

Inheritance diagram for TPolyMarker:
[legend]

Constructor & Destructor Documentation

◆ TPolyMarker() [1/5]

TPolyMarker::TPolyMarker ( )

Default constructor.

Definition at line 33 of file TPolyMarker.cxx.

◆ TPolyMarker() [2/5]

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

Constructor.

Definition at line 43 of file TPolyMarker.cxx.

◆ TPolyMarker() [3/5]

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

Constructor.

Definition at line 62 of file TPolyMarker.cxx.

◆ TPolyMarker() [4/5]

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

Constructor.

Definition at line 84 of file TPolyMarker.cxx.

◆ TPolyMarker() [5/5]

TPolyMarker::TPolyMarker ( const TPolyMarker polymarker)

Copy constructor.

Definition at line 127 of file TPolyMarker.cxx.

◆ ~TPolyMarker()

TPolyMarker::~TPolyMarker ( )
override

Destructor.

Definition at line 117 of file TPolyMarker.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 78 of file TPolyMarker.h.

◆ Copy()

void TPolyMarker::Copy ( TObject object) const
overridevirtual

Copy this to obj.

Reimplemented from TObject.

Definition at line 138 of file TPolyMarker.cxx.

◆ DeclFileName()

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

Definition at line 78 of file TPolyMarker.h.

◆ DistancetoPrimitive()

Int_t TPolyMarker::DistancetoPrimitive ( Int_t  px,
Int_t  py 
)
overridevirtual

Compute distance from point px,py to a polymarker.

Compute the closest distance of approach from point px,py to each point of the polymarker. Returns when the distance found is below DistanceMaximum. The distance is computed in pixels units.

Reimplemented from TObject.

Definition at line 169 of file TPolyMarker.cxx.

◆ Draw()

void TPolyMarker::Draw ( Option_t option = "")
overridevirtual

Draw.

Reimplemented from TObject.

Definition at line 189 of file TPolyMarker.cxx.

◆ DrawPolyMarker()

void TPolyMarker::DrawPolyMarker ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

Draw polymarker.

Definition at line 197 of file TPolyMarker.cxx.

◆ ExecuteEvent()

void TPolyMarker::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
overridevirtual

Execute action corresponding to one event.

This member function must be implemented to realize the action corresponding to the mouse click on the object in the window

Reimplemented from TObject.

Definition at line 212 of file TPolyMarker.cxx.

◆ GetLastPoint()

virtual Int_t TPolyMarker::GetLastPoint ( ) const
inlinevirtual

Get the index of the last filled point.

Note
In case the TPolyMarker was filled in sequential order, the returned value + 1 matches the total number of points used (and is less or equal than the capacity GetN()).

Definition at line 56 of file TPolyMarker.h.

◆ GetN()

virtual Int_t TPolyMarker::GetN ( ) const
inlinevirtual

Get the current capacity (reserved size) of the TPolyMarker.

Note
In contrast to TGraph::GetN(), this does not necessarily match with the used points
Warning
Do not add points via SetPoint(pm->GetN(), x, y) as with a TGraph, use instead TPolyMarker::SetNextPoint
See also
GetLastPoint()

Definition at line 61 of file TPolyMarker.h.

◆ GetOption()

Option_t * TPolyMarker::GetOption ( ) const
inlineoverridevirtual

Reimplemented from TObject.

Definition at line 62 of file TPolyMarker.h.

◆ GetX()

Double_t * TPolyMarker::GetX ( ) const
inline

Definition at line 63 of file TPolyMarker.h.

◆ GetY()

Double_t * TPolyMarker::GetY ( ) const
inline

Definition at line 64 of file TPolyMarker.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 78 of file TPolyMarker.h.

◆ ls()

void TPolyMarker::ls ( Option_t option = "") const
overridevirtual

ls.

Reimplemented from TObject.

Definition at line 219 of file TPolyMarker.cxx.

◆ Merge()

Int_t TPolyMarker::Merge ( TCollection list)
virtual

Merge polymarkers in the collection in this polymarker.

Definition at line 228 of file TPolyMarker.cxx.

◆ operator=()

TPolyMarker & TPolyMarker::operator= ( const TPolyMarker pm)
protected

assignment operator

Definition at line 106 of file TPolyMarker.cxx.

◆ Paint()

void TPolyMarker::Paint ( Option_t option = "")
overridevirtual

Paint.

Reimplemented from TObject.

Definition at line 264 of file TPolyMarker.cxx.

◆ PaintPolyMarker()

void TPolyMarker::PaintPolyMarker ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

Paint polymarker.

Definition at line 272 of file TPolyMarker.cxx.

◆ Print()

void TPolyMarker::Print ( Option_t option = "") const
overridevirtual

Print polymarker.

Reimplemented from TObject.

Definition at line 294 of file TPolyMarker.cxx.

◆ SavePrimitive()

void TPolyMarker::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 302 of file TPolyMarker.cxx.

◆ SetNextPoint()

Int_t TPolyMarker::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 329 of file TPolyMarker.cxx.

◆ SetPoint()

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

Set point number n.

if n is greater than the current size, the arrays are automatically extended

Definition at line 341 of file TPolyMarker.cxx.

◆ SetPolyMarker() [1/3]

void TPolyMarker::SetPolyMarker ( Int_t  n)
virtual

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

Definition at line 371 of file TPolyMarker.cxx.

◆ SetPolyMarker() [2/3]

void TPolyMarker::SetPolyMarker ( Int_t  n,
Double_t x,
Double_t y,
Option_t option = "" 
)
virtual

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

Definition at line 413 of file TPolyMarker.cxx.

◆ SetPolyMarker() [3/3]

void TPolyMarker::SetPolyMarker ( Int_t  n,
Float_t x,
Float_t y,
Option_t option = "" 
)
virtual

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

Definition at line 387 of file TPolyMarker.cxx.

◆ Size()

virtual Int_t TPolyMarker::Size ( ) const
inlinevirtual

Definition at line 76 of file TPolyMarker.h.

◆ Streamer()

void TPolyMarker::Streamer ( TBuffer R__b)
overridevirtual

Stream a class object.

Reimplemented from TObject.

Definition at line 439 of file TPolyMarker.cxx.

◆ StreamerNVirtual()

void TPolyMarker::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 78 of file TPolyMarker.h.

Member Data Documentation

◆ fLastPoint

Int_t TPolyMarker::fLastPoint {-1}
protected

The index of the last filled point.

Definition at line 34 of file TPolyMarker.h.

◆ fN

Int_t TPolyMarker::fN {0}
protected

Number of points internally reserved (not necessarily used)

Definition at line 33 of file TPolyMarker.h.

◆ fOption

TString TPolyMarker::fOption
protected

Options.

Definition at line 37 of file TPolyMarker.h.

◆ fX

Double_t* TPolyMarker::fX {nullptr}
protected

[fN] Array of X coordinates

Definition at line 35 of file TPolyMarker.h.

◆ fY

Double_t* TPolyMarker::fY {nullptr}
protected

[fN] Array of Y coordinates

Definition at line 36 of file TPolyMarker.h.

Libraries for TPolyMarker:

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