A base class for plots of primitive objects. More...

#include <PrimitivePlotter.h>

Inheritance diagram for PrimitivePlotter:

Public Types
using	AttributeMap = Belle2::TrackFindingCDC::AttributeMap
	A map type for attributes names to values for additional drawing information.

Public Member Functions
	PrimitivePlotter ()
	Default constructor for ROOT compatibility.

virtual	~PrimitivePlotter ()
	Make destructor virtual to handle polymorphic deconstruction.

virtual std::unique_ptr< PrimitivePlotter >	clone () const
	Returns a newly created plotter instance containing all information of this.

virtual void	drawLine (float startX, float startY, float endX, float endY, const AttributeMap &attributeMap=AttributeMap())
	Adds a line to the plot.

virtual void	drawArrow (float startX, float startY, float endX, float endY, const AttributeMap &attributeMap=AttributeMap())
	Adds an arrow to the plot.

virtual void	drawCircle (float centerX, float centerY, float radius, const AttributeMap &attributeMap=AttributeMap())
	Adds a circle to the plot.

virtual void	drawCircleArc (float startX, float startY, float endX, float endY, float radius, bool longArc, bool sweepFlag, const AttributeMap &attributeMap=AttributeMap())
	Adds a circle arc to the plot.

virtual void	drawCurve (const std::vector< std::array< float, 2 > > &points, const std::vector< std::array< float, 2 > > &tangents, const AttributeMap &attributeMap=AttributeMap())
	Adds a smooth curve to the plot.

virtual void	startGroup (const AttributeMap &attributeMap=AttributeMap())
	Indicates the start of a group of drawn elements.

virtual void	endGroup ()
	Indicates the end of a group of drawn elements.

virtual const std::string	save (const std::string &fileName)
	Saves the current plot state to a file.

virtual void	clear ()
	Clears all drawn elements from the plotter.

void	clearBoundingBox ()
	Clears the current bounding box. Only following draw calls contribute to the bounding box.

const BoundingBox &	getBoundingBox () const
	Getter for the bounding box of all drawn objects.

void	setBoundingBox (const BoundingBox &boundingBox)
	Setter for the bounding box of all drawn objects.

float	getCanvasWidth ()
	Getter for the canvas width in pixels.

float	getCanvasHeight ()
	Getter for the canvas height in pixels.

void	setCanvasWidth (float width)
	Setter for the canvas width in pixels.

void	setCanvasHeight (float height)
	Setter for the canvas height in pixels The canvas height denotes the size of the image being produced.

Static Public Attributes
static const float	s_defaultCanvasWidth = 1120.0
	The default width of the canvas to be plotted into.

static const float	s_defaultCanvasHeight = 1120.0
	The default height of the canvas to be plotted into.

Private Attributes
BoundingBox	m_boundingBox
	Bounding box of the currently drawn objects.

float	m_canvasWidth
	Memory for the width of the SVG drawing in pixels.

float	m_canvasHeight
	Memory for the height of the SVG drawing in pixels.

Detailed Description

A base class for plots of primitive objects.

Definition at line 25 of file PrimitivePlotter.h.

Member Typedef Documentation

◆ AttributeMap

using AttributeMap = Belle2::TrackFindingCDC::AttributeMap

A map type for attributes names to values for additional drawing information.

Definition at line 29 of file PrimitivePlotter.h.

Constructor & Destructor Documentation

◆ PrimitivePlotter()

PrimitivePlotter ( )

Default constructor for ROOT compatibility.

Definition at line 16 of file PrimitivePlotter.cc.

                                   :
  m_boundingBox(),
  m_canvasWidth(s_defaultCanvasWidth),
  m_canvasHeight(s_defaultCanvasHeight)
{
}

Member Function Documentation

◆ clear()

void clear ( )

virtual

Clears all drawn elements from the plotter.

Base implementation only updates the bounding box.

Reimplemented in SVGPrimitivePlotter.

Definition at line 111 of file PrimitivePlotter.cc.

112{

113}

◆ clearBoundingBox()

void clearBoundingBox ( )

Clears the current bounding box. Only following draw calls contribute to the bounding box.

Definition at line 115 of file PrimitivePlotter.cc.

{
  m_boundingBox.clear();
}

◆ clone()

std::unique_ptr< PrimitivePlotter > clone ( ) const

virtual

Returns a newly created plotter instance containing all information of this.

The new object is created on the heap. The ownership is to the caller who has the responsibility to destroy it.

Reimplemented in SVGPrimitivePlotter.

Definition at line 25 of file PrimitivePlotter.cc.

{
  return std::make_unique<PrimitivePlotter>(*this);
}

◆ drawArrow()

void drawArrow	(	float	startX,
		float	startY,
		float	endX,
		float	endY,
		const AttributeMap &	attributeMap = `AttributeMap()`
	)

virtual

Adds an arrow to the plot.

Base implementation only updates the bounding box.

Parameters

startX	x coordinate where the arrow starts.
startY	y coordinate where the arrow starts.
endX	x coordinate where the arrow ends.
endY	y coordinate where the arrow ends.
attributeMap	A map of string keys and values that describe the drawing properties of the line.

Reimplemented in SVGPrimitivePlotter.

Definition at line 42 of file PrimitivePlotter.cc.

{
  m_boundingBox &= BoundingBox(startX, startY, endX, endY);
}

◆ drawCircle()

void drawCircle	(	float	centerX,
		float	centerY,
		float	radius,
		const AttributeMap &	attributeMap = `AttributeMap()`
	)

virtual

Adds a circle to the plot.

Base implementation only updates the bounding box.

Parameters

centerX	x coordinate of the circle center.
centerY	y coordinate of the circle center.
radius	radius of the circle
attributeMap	A map of string keys and values that describe the drawing properties of the line.

Reimplemented in SVGPrimitivePlotter.

Definition at line 52 of file PrimitivePlotter.cc.

{
  const float left = centerX - radius;
  const float bottom = centerY - radius;
  const float right = centerX + radius;
  const float top = centerY + radius;
 
  m_boundingBox &= BoundingBox(left, bottom, right, top);
}

◆ drawCircleArc()

void drawCircleArc	(	float	startX,
		float	startY,
		float	endX,
		float	endY,
		float	radius,
		bool	longArc,
		bool	sweepFlag,
		const AttributeMap &	attributeMap = `AttributeMap()`
	)

virtual

Adds a circle arc to the plot.

Base implementation only updates the bounding box.

Parameters

startX	x coordinate where the line starts.
startY	y coordinate where the line starts.
endX	x coordinate where the line end.
endY	y coordinate where the line end.
radius	Radius of the circle
longArc	Boolean indicator if the long arc or the short arc is traversed from one point to the other.
sweepFlag	Boolean indicator related to the curvature perceived one the circle arc. False means negative curvature. True mean positive curvature.
attributeMap	A map of string keys and values that describe the drawing properties of the line.

Reimplemented in SVGPrimitivePlotter.

Definition at line 66 of file PrimitivePlotter.cc.

{
  // The actual extend of the circle arc is more complicating.
  // Please fill in the solution if you have one.
  m_boundingBox &= BoundingBox(startX, startY, endX, endY);
}

◆ drawCurve()

void drawCurve	(	const std::vector< std::array< float, 2 > > &	points,
		const std::vector< std::array< float, 2 > > &	tangents,
		const AttributeMap &	attributeMap = `AttributeMap()`
	)

virtual

Adds a smooth curve to the plot.

Base implementation only updates the bounding box.

Parameters

points	X,Y points on the curve
tangents	Tangent vector at each point. Length of tangents does not matter.
attributeMap	A map of string keys and values that describe the drawing properties of the line.

Reimplemented in SVGPrimitivePlotter.

Definition at line 80 of file PrimitivePlotter.cc.

{
  for (size_t i = 0; i < points.size() - 1; ++i) {
    float startX = points[i][0];
    float startY = points[i][1];
    float endX = points[i + 1][0];
    float endY = points[i + 1][1];
    m_boundingBox &= BoundingBox(startX, startY, endX, endY);
  }
}

◆ drawLine()

void drawLine	(	float	startX,
		float	startY,
		float	endX,
		float	endY,
		const AttributeMap &	attributeMap = `AttributeMap()`
	)

virtual

Adds a line to the plot.

Base implementation only updates the bounding box.

Parameters

startX	x coordinate where the line starts.
startY	y coordinate where the line starts.
endX	x coordinate where the line ends.
endY	y coordinate where the line ends.
attributeMap	A map of string keys and values that describe the drawing properties of the line.

Reimplemented in SVGPrimitivePlotter.

Definition at line 32 of file PrimitivePlotter.cc.

{
  m_boundingBox &= BoundingBox(startX, startY, endX, endY);
}

◆ endGroup()

void endGroup ( )

virtual

Indicates the end of a group of drawn elements.

Meaning depends on the actual implementation.

Does nothing in the base implementation

Reimplemented in SVGPrimitivePlotter.

Definition at line 100 of file PrimitivePlotter.cc.

101{

102}

◆ getBoundingBox()

const BoundingBox & getBoundingBox ( ) const

inline

Getter for the bounding box of all drawn objects.

Definition at line 189 of file PrimitivePlotter.h.

      {
        return m_boundingBox;
      }

◆ getCanvasHeight()

float getCanvasHeight ( )

inline

Getter for the canvas height in pixels.

Definition at line 208 of file PrimitivePlotter.h.

      {
        return m_canvasHeight;
      }

◆ getCanvasWidth()

float getCanvasWidth ( )

inline

Getter for the canvas width in pixels.

Definition at line 202 of file PrimitivePlotter.h.

      {
        return m_canvasWidth;
      }

◆ save()

const std::string save ( const std::string & fileName )

virtual

Saves the current plot state to a file.

Deriving instances may should implement the appropriate thing here and may return a modified string indicating the file name to which the plot as been written. It is allowed to append or change the file extension if the concrete implementation decides to do so.

Parameters

fileName File name where the plot shall be saved

Returns: Potentially modified file name where the file has actually been written to.

Reimplemented in SVGPrimitivePlotter.

Definition at line 105 of file PrimitivePlotter.cc.

{
  return "";
}

◆ setBoundingBox()

void setBoundingBox ( const BoundingBox & boundingBox )

inline

Setter for the bounding box of all drawn objects.

Definition at line 195 of file PrimitivePlotter.h.

      {
        m_boundingBox = boundingBox;
      }

◆ setCanvasHeight()

void setCanvasHeight ( float height )

inline

Setter for the canvas height in pixels The canvas height denotes the size of the image being produced.

The coordinates space that is visible in the picture is a separate concept which is stored in the bounding box (getBoundingBox()).

Definition at line 230 of file PrimitivePlotter.h.

      {
        m_canvasHeight = height;
      }

◆ setCanvasWidth()

void setCanvasWidth ( float width )

inline

Setter for the canvas width in pixels.

The canvas height denotes the size of the image being produced. The coordinates space that is visible in the picture is a separate concept which is stored in the bounding box (getBoundingBox()).

Definition at line 219 of file PrimitivePlotter.h.

      {
        m_canvasWidth = width;
      }

◆ startGroup()

void startGroup ( const AttributeMap & attributeMap = AttributeMap() )

virtual

Indicates the start of a group of drawn elements.

Meaning depends on the actual implementation.

Does nothing in the base implementation

Reimplemented in SVGPrimitivePlotter.

Definition at line 95 of file PrimitivePlotter.cc.

96{

97}

Member Data Documentation

◆ m_boundingBox

BoundingBox m_boundingBox

private

Bounding box of the currently drawn objects.

Definition at line 237 of file PrimitivePlotter.h.

◆ m_canvasHeight

float m_canvasHeight

private

Memory for the height of the SVG drawing in pixels.

Definition at line 243 of file PrimitivePlotter.h.

◆ m_canvasWidth

float m_canvasWidth

private

Memory for the width of the SVG drawing in pixels.

Definition at line 240 of file PrimitivePlotter.h.

◆ s_defaultCanvasHeight

const float s_defaultCanvasHeight = 1120.0

static

The default height of the canvas to be plotted into.

Definition at line 36 of file PrimitivePlotter.h.

◆ s_defaultCanvasWidth

const float s_defaultCanvasWidth = 1120.0

static

The default width of the canvas to be plotted into.

Definition at line 33 of file PrimitivePlotter.h.

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

tracking/trackFindingCDC/display/include/PrimitivePlotter.h
tracking/trackFindingCDC/display/src/PrimitivePlotter.cc

Public Types

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AttributeMap

Constructor & Destructor Documentation

◆ PrimitivePlotter()

Member Function Documentation

◆ clear()

◆ clearBoundingBox()

◆ clone()

◆ drawArrow()

◆ drawCircle()

◆ drawCircleArc()

◆ drawCurve()

◆ drawLine()

◆ endGroup()

◆ getBoundingBox()

◆ getCanvasHeight()

◆ getCanvasWidth()

◆ save()

◆ setBoundingBox()

◆ setCanvasHeight()

◆ setCanvasWidth()

◆ startGroup()

Member Data Documentation

◆ m_boundingBox

◆ m_canvasHeight

◆ m_canvasWidth

◆ s_defaultCanvasHeight

◆ s_defaultCanvasWidth