Gtkmm-PLplot 3.0
A scientific plotting library for Gtkmm
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Gtk::PLplot::PlotObject2D Class Referenceabstract

the abstract base class that will hold a single plot object and its properties that can be added to a plot containing 2D data, such as Plot2D, PlotContour, PlotPolar and PlotHistogram More...

#include <gtkmm-plplot/plotobject2d.h>

Inheritance diagram for Gtk::PLplot::PlotObject2D:
Inheritance graph
[legend]

Public Member Functions

virtual ~PlotObject2D ()
 
void set_color (Gdk::RGBA color)
 
Gdk::RGBA get_color ()
 
virtual bool is_logarithmic_x_compatible ()=0
 
virtual bool is_logarithmic_y_compatible ()=0
 
- Public Member Functions inherited from Gtk::PLplot::PlotObject
virtual ~PlotObject ()
 
void show ()
 
void hide ()
 
bool is_showing () const
 
sigc::signal< void(void)> signal_changed ()
 
virtual void draw_plot_object (const Cairo::RefPtr< Cairo::Context > &cr, plstream *pls, PlotObjectAuxData &data)=0
 
- Public Member Functions inherited from Gtk::PLplot::Object
virtual void set_manage ()
 

Protected Member Functions

 PlotObject2D (Gdk::RGBA color)
 
- Protected Member Functions inherited from Gtk::PLplot::PlotObject
virtual void on_changed ()
 
 PlotObject ()
 
- Protected Member Functions inherited from Gtk::PLplot::Object
 Object ()
 

Protected Attributes

Gdk::RGBA color
 The color the dataset will be drawn in.
 
- Protected Attributes inherited from Gtk::PLplot::PlotObject
sigc::signal< void(void)> _signal_changed
 signal that gets emitted whenever any of the plot object properties is changed.
 

Private Member Functions

 PlotObject2D ()=delete
 no default constructor
 
PlotObject2Doperator= (const PlotObject2D &)=delete
 no assignment operator
 
 PlotObject2D (const PlotObject2D &source)=delete
 no default copy constructor;
 

Detailed Description

the abstract base class that will hold a single plot object and its properties that can be added to a plot containing 2D data, such as Plot2D, PlotContour, PlotPolar and PlotHistogram

The base class that all other PlotObject classes ultimately derive from. Examples are PlotLine2D and PlotText2D

Constructor & Destructor Documentation

◆ PlotObject2D() [1/3]

Gtk::PLplot::PlotObject2D::PlotObject2D ( )
privatedelete

no default constructor

◆ PlotObject2D() [2/3]

Gtk::PLplot::PlotObject2D::PlotObject2D ( const PlotObject2D source)
privatedelete

no default copy constructor;

◆ PlotObject2D() [3/3]

Gtk::PLplot::PlotObject2D::PlotObject2D ( Gdk::RGBA  color)
protected

Constructor

This constructor initializes a new PlotObject2D instance, by setting the properties that will determine its appearance when rendered onto a plot

Parameters
colorthe line color

◆ ~PlotObject2D()

virtual Gtk::PLplot::PlotObject2D::~PlotObject2D ( )
virtual

Destructor

Member Function Documentation

◆ get_color()

Gdk::RGBA Gtk::PLplot::PlotObject2D::get_color ( )

Get the current dataset color

Returns
the current dataset color

◆ is_logarithmic_x_compatible()

virtual bool Gtk::PLplot::PlotObject2D::is_logarithmic_x_compatible ( )
pure virtual

Check if the object can be used in a plot with a logarithmic X-axis

Returns
true if compatible, false if not

Implemented in Gtk::PLplot::PlotObject2DLine, and Gtk::PLplot::PlotObject2DText.

◆ is_logarithmic_y_compatible()

virtual bool Gtk::PLplot::PlotObject2D::is_logarithmic_y_compatible ( )
pure virtual

Check if the object can be used in a plot with a logarithmic Y-axis

Returns
true if compatible, false if not

Implemented in Gtk::PLplot::PlotObject2DLine, and Gtk::PLplot::PlotObject2DText.

◆ operator=()

PlotObject2D & Gtk::PLplot::PlotObject2D::operator= ( const PlotObject2D )
privatedelete

no assignment operator

◆ set_color()

void Gtk::PLplot::PlotObject2D::set_color ( Gdk::RGBA  color)

Changes the color of the dataset

Parameters
colorThe new dataset color

Member Data Documentation

◆ color

Gdk::RGBA Gtk::PLplot::PlotObject2D::color
protected

The color the dataset will be drawn in.