MuonValR4::IRootVisualizationService::ICanvasObject Struct Reference

Interface to the container class to temporarily cache the ROOT objects to be drawn on a TCanvas and then saved to disk. More...

#include <IRootVisualizationService.h>

Inheritance diagram for MuonValR4::IRootVisualizationService::ICanvasObject:

Collaboration diagram for MuonValR4::IRootVisualizationService::ICanvasObject:

Public Types
enum class	AxisRanges : std::uint8_t { xLow , xHigh , yLow , yHigh }
	Enum to select the corner coordinates shown by the plot. More...

Public Member Functions
	~ICanvasObject ()=default
	Default destructor.
virtual double	corner (const AxisRanges r) const =0
	Retrieves a corner coordinate of the drawn canvas.
virtual void	expandPad (const double x, const double y)=0
	Expands the axes of the pad such that the coordinates are guaranteed to appear at least at the Canvas edges.
virtual void	setRangeScale (const double s, bool quadCan=true)=0
	To ensure that the drawn objects are not cut by the axis limits, a flat scale-factor on the drawn axis intervals can be applied.
virtual void	add (PrimitivePtr_t &&drawMe, const std::string &drawOpt="")=0
	Add a TObject to the ICanvasObject for later drawing onto a TCanvas.
virtual void	add (PrimitiveVec_t &&drawMe)=0
	Add a vector of TObjects to the ICanvasObject for later drawing onto a TCanvas.
virtual void	setAxisTitles (const std::string &xTitle="", const std::string &yTitle="", const std::string &zTitle="")=0
	Define the titles of the Canvas axes.
virtual void	trash ()=0
	If no object has been drawn mark the plot as junk.

Detailed Description

Interface to the container class to temporarily cache the ROOT objects to be drawn on a TCanvas and then saved to disk.

Definition at line 73 of file IRootVisualizationService.h.

Member Enumeration Documentation

AxisRanges

enum class MuonValR4::IRootVisualizationService::ICanvasObject::AxisRanges : std::uint8_t

strong

Enum to select the corner coordinates shown by the plot.

Enumerator
xLow
xHigh
yLow
yHigh

Definition at line 78 of file IRootVisualizationService.h.

                                         : std::uint8_t{
                        xLow, xHigh, yLow, yHigh
                    };

Constructor & Destructor Documentation

~ICanvasObject()

MuonValR4::IRootVisualizationService::ICanvasObject::~ICanvasObject ( )

default

Default destructor.

Member Function Documentation

add() [1/2]

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::add ( PrimitivePtr_t && drawMe, const std::string & drawOpt = "" )

pure virtual

Add a TObject to the ICanvasObject for later drawing onto a TCanvas.

Parameters

drawMe	Unique_ptr to the object to be drawn
drawOpt	Option to be parsed to the draw command later (e.g. HIST)

Implemented in MuonValR4::detail::DrawCanvasObject.

add() [2/2]

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::add ( PrimitiveVec_t && drawMe )

pure virtual

Add a vector of TObjects to the ICanvasObject for later drawing onto a TCanvas.

Parameters

drawMe

List of unique TObject pointers

corner()

virtual double MuonValR4::IRootVisualizationService::ICanvasObject::corner ( const AxisRanges r ) const

pure virtual

Retrieves a corner coordinate of the drawn canvas.

Parameters

r	Coordinate to return

Implemented in MuonValR4::detail::DrawCanvasObject.

expandPad()

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::expandPad ( const double x, const double y )

pure virtual

Expands the axes of the pad such that the coordinates are guaranteed to appear at least at the Canvas edges.

Parameters

x	Expansion in the width of the canvas
y	Expansion in the height of the canvas

Implemented in MuonValR4::detail::DrawCanvasObject.

setAxisTitles()

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::setAxisTitles ( const std::string & xTitle = "", const std::string & yTitle = "", const std::string & zTitle = "" )

pure virtual

Define the titles of the Canvas axes.

Parameters

xTitle	Title pf the x-axis
yTitle	Title pf the y-axis
zTitle	Title pf the z-axis

Implemented in MuonValR4::detail::DrawCanvasObject.

setRangeScale()

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::setRangeScale ( const double s, bool quadCan = true )

pure virtual

To ensure that the drawn objects are not cut by the axis limits, a flat scale-factor on the drawn axis intervals can be applied.

Parameters

s	scale-factor >1.
quadCan	Switch toggling whether the drawn intervals have an equal size

Implemented in MuonValR4::detail::DrawCanvasObject.

trash()

virtual void MuonValR4::IRootVisualizationService::ICanvasObject::trash ( )

pure virtual

If no object has been drawn mark the plot as junk.

Implemented in MuonValR4::detail::DrawCanvasObject.

---

The documentation for this struct was generated from the following file:

• IRootVisualizationService.h