scatter 0.1.0
scatter::ColourGridPlot Class Reference

[brief description] More...

#include <ColourGridPlot.hpp>

Inheritance diagram for scatter::ColourGridPlot:
scatter::PlotBase

Classes

class  Options
 [brief description] More...
 

Public Types

typedef std::unique_ptr< ColourGridPlotPtr
 convenience typedef
 

Public Member Functions

 ColourGridPlot (const std::string &label, const Eigen::MatrixXd &values, const Options &options)
 constructor
 
 ColourGridPlot (const std::string &label, const std::function< double(const double &, const double &)> &function, int resolution, const Options &options)
 
virtual ~ColourGridPlot ()
 destuctor
 
Legend::Entry getLegendEntry ()
 create LegendEntry
 
void render (Renderer &renderer, const Transform &transform)
 render the ColourGridPlot
 
Optionsoptions ()
 [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 ColourgetColour () const
 [brief description]
 
virtual double getYmax ()
 [brief description]
 

Static Public Member Functions

static Eigen::MatrixXd evaluate (const std::function< double(const double &, const double &)> &function, int resolution, const Options &options)
 

Detailed Description

[brief description]

[long description]

Constructor & Destructor Documentation

◆ ColourGridPlot()

scatter::ColourGridPlot::ColourGridPlot ( const std::string & label,
const Eigen::MatrixXd & values,
const Options & options )

constructor

[long description]

Parameters
values[description]
optionsOptions

◆ ~ColourGridPlot()

virtual scatter::ColourGridPlot::~ColourGridPlot ( )
virtual

destuctor

[long description]

Member Function Documentation

◆ getLegendEntry()

Legend::Entry scatter::ColourGridPlot::getLegendEntry ( )
virtual

create LegendEntry

defines symbol, label, colour

Returns
LegendEntry

Implements scatter::PlotBase.

◆ options()

Options * scatter::ColourGridPlot::options ( )

[brief description]

[long description]

Returns
[description]

◆ render()

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

render the ColourGridPlot

[long description]

Parameters
rendererRenderer (base class)
transformTransform

Implements scatter::PlotBase.


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