scatter::ArrowPlot Class Reference

[brief description] More...

#include <ArrowPlot.hpp>

Inheritance diagram for scatter::ArrowPlot:

Classes
class	Options
	[brief description] More...

Public Types
typedef std::unique_ptr< ArrowPlot >	Ptr
	convenience typedef

Public Member Functions
	ArrowPlot (const std::string &label, const std::vector< Arrow > &arrows, const Options &options)
	[brief description]
	ArrowPlot (const std::vector< Arrow > &arrows, const Options &options)
	constructor
virtual	~ArrowPlot ()
	destuctor
Legend::Entry	getLegendEntry ()
	create LegendEntry
void	render (Renderer &renderer, const Transform &transform)
	render the ArrowPlot
Options *	options ()
	[brief description]
Public Member Functions inherited from scatter::PlotBase
	PlotBase (const std::string &label)
	[brief description]
virtual	~PlotBase ()=default
	[brief description]
void	setLabel (const std::string &label)
	[brief description]
void	setColour (const Colour &colour)
	[brief description]
const std::string &	getLabel () const
	[brief description]
const Colour &	getColour () const
	[brief description]
virtual double	getYmax ()
	[brief description]

Detailed Description

[brief description]

[long description]

Constructor & Destructor Documentation

ArrowPlot() [1/2]

scatter::ArrowPlot::ArrowPlot	(	const std::string &	label,
		const std::vector< Arrow > &	arrows,
		const Options &	options )

[brief description]

[long description]

Parameters

label	[description]
arrows	[description]
options	[description]

ArrowPlot() [2/2]

scatter::ArrowPlot::ArrowPlot	(	const std::vector< Arrow > &	arrows,
		const Options &	options )

constructor

[long description]

Parameters

arrows	array of Arrow
options	Options

~ArrowPlot()

virtual scatter::ArrowPlot::~ArrowPlot ( )

virtual

destuctor

[long description]

Member Function Documentation

getLegendEntry()

Legend::Entry scatter::ArrowPlot::getLegendEntry ( )

virtual

create LegendEntry

defines symbol, label, colour

Returns

LegendEntry

Implements scatter::PlotBase.

options()

Options * scatter::ArrowPlot::options

(

)

[brief description]

[long description]

Returns

[description]

render()

void scatter::ArrowPlot::render ( Renderer & renderer, const Transform & transform )

virtual

render the ArrowPlot

[long description]

Parameters

renderer	Renderer (base class)
transform	Transform

Implements scatter::PlotBase.

---

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

• ArrowPlot.hpp