A 3-dimensional polyline.

It has 4 different constructors.

First one, without any parameters TPolyLine3D(), we call 'default constructor' and it's used in a case that just an initialisation is needed (i.e. pointer declaration).

Example:

TPolyLine3D *pl1 = new TPolyLine3D;

TPolyLine3D

A 3-dimensional polyline.

Definition TPolyLine3D.h:33

TPolyLine3D::TPolyLine3D

TPolyLine3D()

3-D polyline default constructor.

Definition TPolyLine3D.cxx:100

Second one is 'normal constructor' with, usually, one parameter n (number of points), and it just allocates a space for the points.

Example:

TPolyLine3D pl1(150);

Third one allocates a space for the points, and also makes initialisation from the given array.

Example:

TPolyLine3D pl1(150, pointerToAnArray);

Fourth one is, almost, similar to the constructor above, except initialisation is provided with three independent arrays (array of x coordinates, y coordinates and z coordinates).

Example:

TPolyLine3D pl1(150, xArray, yArray, zArray);

Example:

{
   TCanvas *c1 = new TCanvas("c1","c1",500,500);
   TView *view = TView::CreateView(1);
   view->SetRange(0,0,0,2,2,2);
   const Int_t n = 500;
   r = new TRandom();
   Double_t x, y, z;
   TPolyLine3D *l = new TPolyLine3D(n);
   for (Int_t i=0;i<n;i++) {
      r->Sphere(x, y, z, 1);
      l->SetPoint(i,x+1,y+1,z+1);
   }
   l->Draw();
}

TPolyLine3D is a basic graphics primitive which ignores the fact the current pad has logarithmic scale(s). It simply draws the 3D line in the current user coordinates. If logarithmic scale is set along one of the three axis, the logarithm of vector coordinates along this axis should be use. Alternatively and higher level class, knowing about logarithmic scales, might be used. For instance TGraph2D with option L.

Definition at line 32 of file TPolyLine3D.h.

Public Member Functions
	TPolyLine3D ()
	3-D polyline default constructor.

	TPolyLine3D (const TPolyLine3D &polylin)
	3-D polyline copy ctor.

	TPolyLine3D (Int_t n, Double_t const p, Option_t option="")
	3-D polyline normal constructor.

	TPolyLine3D (Int_t n, Double_t const x, Double_t const y, Double_t const z, Option_t option="")
	3-D polyline normal constructor.

	TPolyLine3D (Int_t n, Float_t const p, Option_t option="")
	3-D polyline normal constructor.

	TPolyLine3D (Int_t n, Float_t const x, Float_t const y, Float_t const z, Option_t option="")
	3-D polyline normal constructor.

	TPolyLine3D (Int_t n, Option_t *option="")
	3-D polyline normal constructor with initialization to 0.

virtual	~TPolyLine3D ()
	3-D polyline destructor.

virtual void	Copy (TObject &polyline) const
	Copy polyline to polyline obj.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Compute distance from point px,py to a 3-D polyline.

virtual void	Draw (Option_t *option="")
	Draw this 3-D polyline with its current attributes.

virtual void	DrawPolyLine (Int_t n, Float_t p, Option_t option="")
	Draw 3-D polyline with new coordinates.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to one event.

Int_t	GetLastPoint () const

Int_t	GetN () const

Option_t *	GetOption () const

Float_t *	GetP () const

virtual void	ls (Option_t *option="") const
	List this 3-D polyline.

virtual Int_t	Merge (TCollection *list)
	Merge polylines in the collection in this polyline.

TPolyLine3D &	operator= (const TPolyLine3D &polylin)
	assignment operator

virtual void	Paint (Option_t *option="")
	Paint a TPolyLine3D.

virtual void	Print (Option_t *option="") const
	Dump this 3-D polyline with its attributes on stdout.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save primitive as a C++ statement(s) on output stream.

virtual Int_t	SetNextPoint (Double_t x, Double_t y, Double_t z)
	Set point following LastPoint to x, y, z.

virtual void	SetOption (Option_t *option="")

virtual void	SetPoint (Int_t point, Double_t x, Double_t y, Double_t z)
	Set point n to x, y, z.

virtual void	SetPolyLine (Int_t n, Double_t p, Option_t option="")
	Re-initialize polyline with n points from p.

virtual void	SetPolyLine (Int_t n, Float_t p, Option_t option="")
	Re-initialize polyline with n points from p.

virtual void	SetPolyLine (Int_t n, Option_t *option="")
	Re-initialize polyline with n points (0,0,0).

virtual Int_t	Size () const

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 TObject *	Clone (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 TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () 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.

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)
	Operator delete [].

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)

TObject &	operator= (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.

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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from TAttLine
	TAttLine ()
	AttLine default constructor.

	TAttLine (Color_t lcolor, Style_t lstyle, Width_t lwidth)
	AttLine normal constructor.

virtual	~TAttLine ()
	AttLine destructor.

void	Copy (TAttLine &attline) const
	Copy this line attributes to a new TAttLine.

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.

virtual Color_t	GetLineColor () const
	Return the line color.

virtual Style_t	GetLineStyle () const
	Return the line style.

virtual Width_t	GetLineWidth () const
	Return the line width.

virtual void	Modify ()
	Change current line attributes if necessary.

virtual void	ResetAttLine (Option_t *option="")
	Reset this line attributes to default values.

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.

virtual void	SetLineAttributes ()
	Invoke the DialogCanvas Line attributes.

virtual void	SetLineColor (Color_t lcolor)
	Set the line color.

virtual void	SetLineColorAlpha (Color_t lcolor, Float_t lalpha)
	Set a transparent line color.

virtual void	SetLineStyle (Style_t lstyle)
	Set the line style.

virtual void	SetLineWidth (Width_t lwidth)
	Set the line width.

Public Member Functions inherited from TAtt3D
	TAtt3D ()

virtual	~TAtt3D ()

virtual void	Sizeof3D () const
	Set total size of this 3D object (used by X3D interface).

Static Public Member Functions
static void	DrawOutlineCube (TList outline, Double_t rmin, Double_t *rmax)
	Draw cube outline with 3d polylines.

Static Public Member Functions inherited from TObject
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 Attributes
Int_t	fLastPoint
	The index of the last filled point.

Int_t	fN
	Number of points.

TString	fOption
	options

Float_t *	fP
	[3*fN] Array of 3-D coordinates (x,y,z)

Protected Attributes inherited from TAttLine
Color_t	fLineColor
	Line color.

Style_t	fLineStyle
	Line style.

Width_t	fLineWidth
	Line width.

Additional Inherited Members
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) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

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

#include <TPolyLine3D.h>

Inheritance diagram for TPolyLine3D:

[legend]

Constructor & Destructor Documentation

◆ TPolyLine3D() [1/7]

TPolyLine3D::TPolyLine3D ( )

3-D polyline default constructor.

Definition at line 100 of file TPolyLine3D.cxx.

◆ TPolyLine3D() [2/7]

TPolyLine3D::TPolyLine3D	(	Int_t	n,
		Option_t *	option = `""`
	)

3-D polyline normal constructor with initialization to 0.

If n < 0 the default size (2 points) is set.

Definition at line 111 of file TPolyLine3D.cxx.

◆ TPolyLine3D() [3/7]

TPolyLine3D::TPolyLine3D	(	Int_t	n,
		Float_t const *	p,
		Option_t *	option = `""`
	)

3-D polyline normal constructor.

Polyline is intialized with p. If n < 0 the default size (2 points) is set.

Definition at line 131 of file TPolyLine3D.cxx.

◆ TPolyLine3D() [4/7]

TPolyLine3D::TPolyLine3D	(	Int_t	n,
		Double_t const *	p,
		Option_t *	option = `""`
	)

3-D polyline normal constructor.

Polyline is initialized with p (cast to float). If n < 0 the default size (2 points) is set.

Definition at line 154 of file TPolyLine3D.cxx.

◆ TPolyLine3D() [5/7]

TPolyLine3D::TPolyLine3D	(	Int_t	n,
		Float_t const *	x,
		Float_t const *	y,
		Float_t const *	z,
		Option_t *	option = `""`
	)

3-D polyline normal constructor.

Polyline is initialized withe the x, y ,z arrays. If n < 0 the default size (2 points) is set.

Definition at line 177 of file TPolyLine3D.cxx.

◆ TPolyLine3D() [6/7]

TPolyLine3D::TPolyLine3D	(	Int_t	n,
		Double_t const *	x,
		Double_t const *	y,
		Double_t const *	z,
		Option_t *	option = `""`
	)

3-D polyline normal constructor.

Polyline is initialized withe the x, y, z arrays (which are cast to float). If n < 0 the default size (2 points) is set.

Definition at line 205 of file TPolyLine3D.cxx.

◆ TPolyLine3D() [7/7]

TPolyLine3D::TPolyLine3D ( const TPolyLine3D & polylin )

3-D polyline copy ctor.

Definition at line 249 of file TPolyLine3D.cxx.

◆ ~TPolyLine3D()

TPolyLine3D::~TPolyLine3D ( )

virtual

3-D polyline destructor.

Definition at line 241 of file TPolyLine3D.cxx.

Member Function Documentation

◆ Copy()

void TPolyLine3D::Copy ( TObject & polyline ) const

virtual

Copy polyline to polyline obj.

Reimplemented from TObject.

Reimplemented in THelix.

Definition at line 260 of file TPolyLine3D.cxx.

◆ DistancetoPrimitive()

Int_t TPolyLine3D::DistancetoPrimitive	(	Int_t	px,
		Int_t	py
	)

virtual

Compute distance from point px,py to a 3-D polyline.

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

Reimplemented from TObject.

Definition at line 286 of file TPolyLine3D.cxx.

◆ Draw()

void TPolyLine3D::Draw ( Option_t * option = "" )

virtual

Draw this 3-D polyline with its current attributes.

Reimplemented from TObject.

Reimplemented in THelix.

Definition at line 324 of file TPolyLine3D.cxx.

◆ DrawOutlineCube()

void TPolyLine3D::DrawOutlineCube	(	TList *	outline,
		Double_t *	rmin,
		Double_t *	rmax
	)

static

Draw cube outline with 3d polylines.

      xmin = fRmin[0]        xmax = fRmax[0]
      ymin = fRmin[1]        ymax = fRmax[1]
      zmin = fRmin[2]        zmax = fRmax[2]
 
    (xmin,ymax,zmax) +---------+ (xmax,ymax,zmax)
                    /         /|
                   /         / |
                  /         /  |
(xmin,ymin,zmax) +---------+   |
                 |         |   + (xmax,ymax,zmin)
                 |         |  /
                 |         | /
                 |         |/
                 +---------+
  (xmin,ymin,zmin)         (xmax,ymin,zmin)

Definition at line 350 of file TPolyLine3D.cxx.

◆ DrawPolyLine()

void TPolyLine3D::DrawPolyLine	(	Int_t	n,
		Float_t *	p,
		Option_t *	option = `""`
	)

virtual

Draw 3-D polyline with new coordinates.

Creates a new polyline which will be adopted by the pad in which it is drawn. Does not change the original polyline (should be static method).

Definition at line 418 of file TPolyLine3D.cxx.

◆ ExecuteEvent()

void TPolyLine3D::ExecuteEvent	(	Int_t	event,
		Int_t	px,
		Int_t	py
	)

virtual

Execute action corresponding to one event.

Reimplemented from TObject.

Definition at line 435 of file TPolyLine3D.cxx.

◆ GetLastPoint()

Int_t TPolyLine3D::GetLastPoint ( ) const

inline

Definition at line 56 of file TPolyLine3D.h.

◆ GetN()

Int_t TPolyLine3D::GetN ( ) const

inline

Definition at line 57 of file TPolyLine3D.h.

◆ GetOption()

Option_t * TPolyLine3D::GetOption ( ) const

inlinevirtual

Reimplemented from TObject.

Definition at line 59 of file TPolyLine3D.h.

◆ GetP()

Float_t * TPolyLine3D::GetP ( ) const

inline

Definition at line 58 of file TPolyLine3D.h.

◆ ls()

void TPolyLine3D::ls ( Option_t * option = "" ) const

virtual

List this 3-D polyline.

Reimplemented from TObject.

Definition at line 444 of file TPolyLine3D.cxx.

◆ Merge()

Int_t TPolyLine3D::Merge ( TCollection * list )

virtual

Merge polylines in the collection in this polyline.

Definition at line 453 of file TPolyLine3D.cxx.

◆ operator=()

TPolyLine3D & TPolyLine3D::operator= ( const TPolyLine3D & polylin )

assignment operator

Definition at line 231 of file TPolyLine3D.cxx.

◆ Paint()

void TPolyLine3D::Paint ( Option_t * option = "" )

virtual

Paint a TPolyLine3D.

Reimplemented from TObject.

Definition at line 488 of file TPolyLine3D.cxx.

◆ Print()

void TPolyLine3D::Print ( Option_t * option = "" ) const

virtual

Dump this 3-D polyline with its attributes on stdout.

Reimplemented from TObject.

Reimplemented in THelix.

Definition at line 569 of file TPolyLine3D.cxx.

◆ SavePrimitive()

void TPolyLine3D::SavePrimitive	(	std::ostream &	out,
		Option_t *	option = `""`
	)

virtual

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

Reimplemented from TObject.

Reimplemented in THelix.

Definition at line 584 of file TPolyLine3D.cxx.

◆ SetNextPoint()

Int_t TPolyLine3D::SetNextPoint	(	Double_t	x,
		Double_t	y,
		Double_t	z
	)

virtual

Set point following LastPoint to x, y, z.

Returns index of the point (new last point).

Definition at line 609 of file TPolyLine3D.cxx.

◆ SetOption()

virtual void TPolyLine3D::SetOption ( Option_t * option = "" )

inlinevirtual

Reimplemented in THelix.

Definition at line 66 of file TPolyLine3D.h.

◆ SetPoint()

void TPolyLine3D::SetPoint	(	Int_t	n,
		Double_t	x,
		Double_t	y,
		Double_t	z
	)

virtual

Set point n to x, y, z.

If n is more then the current TPolyLine3D size (n > fN) then the polyline will be resized to contain at least n points.

Definition at line 621 of file TPolyLine3D.cxx.

◆ SetPolyLine() [1/3]

void TPolyLine3D::SetPolyLine	(	Int_t	n,
		Double_t *	p,
		Option_t *	option = `""`
	)

virtual

Re-initialize polyline with n points from p.

If p=0 initialize with 0. if n <= 0 the current array of points is deleted.

Definition at line 696 of file TPolyLine3D.cxx.

◆ SetPolyLine() [2/3]

void TPolyLine3D::SetPolyLine	(	Int_t	n,
		Float_t *	p,
		Option_t *	option = `""`
	)

virtual

Re-initialize polyline with n points from p.

If p=0 initialize with 0. if n <= 0 the current array of points is deleted.

Definition at line 667 of file TPolyLine3D.cxx.

◆ SetPolyLine() [3/3]

void TPolyLine3D::SetPolyLine	(	Int_t	n,
		Option_t *	option = `""`
	)

virtual

Re-initialize polyline with n points (0,0,0).

if n <= 0 the current array of points is deleted.

Definition at line 646 of file TPolyLine3D.cxx.

◆ Size()

virtual Int_t TPolyLine3D::Size ( ) const

inlinevirtual

Definition at line 71 of file TPolyLine3D.h.

Member Data Documentation

◆ fLastPoint

Int_t TPolyLine3D::fLastPoint

protected

The index of the last filled point.

Definition at line 38 of file TPolyLine3D.h.

◆ fN

Int_t TPolyLine3D::fN

protected

Number of points.

Definition at line 35 of file TPolyLine3D.h.

◆ fOption

TString TPolyLine3D::fOption

protected

options

Definition at line 37 of file TPolyLine3D.h.

◆ fP

Float_t* TPolyLine3D::fP

protected

[3*fN] Array of 3-D coordinates (x,y,z)

Definition at line 36 of file TPolyLine3D.h.

Libraries for TPolyLine3D:

[legend]

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

graf3d/g3d/inc/TPolyLine3D.h
graf3d/g3d/src/TPolyLine3D.cxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TPolyLine3D() [1/7]

◆ TPolyLine3D() [2/7]

◆ TPolyLine3D() [3/7]

◆ TPolyLine3D() [4/7]

◆ TPolyLine3D() [5/7]

◆ TPolyLine3D() [6/7]

◆ TPolyLine3D() [7/7]

◆ ~TPolyLine3D()

Member Function Documentation

◆ Copy()

◆ DistancetoPrimitive()

◆ Draw()

◆ DrawOutlineCube()

◆ DrawPolyLine()

◆ ExecuteEvent()

◆ GetLastPoint()

◆ GetN()

◆ GetOption()

◆ GetP()

◆ ls()

◆ Merge()

◆ operator=()

◆ Paint()

◆ Print()

◆ SavePrimitive()

◆ SetNextPoint()

◆ SetOption()

◆ SetPoint()

◆ SetPolyLine() [1/3]

◆ SetPolyLine() [2/3]

◆ SetPolyLine() [3/3]

◆ Size()

Member Data Documentation

◆ fLastPoint

◆ fN

◆ fOption

◆ fP