Navigation

Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
   Version 1.0.6dev
      Class Index
      File List
   Version 1.0.6
   Version 1.0.5new_solver
   Version 1.0.5dev
   Version 1.0.5b
   Version 1.0.4dev
   Version 1.0.4
Publications


Hosted by Get Ion Beam Simulator at SourceForge.net. Fast, secure and Free Open Source software downloads
Legend Class Referenceabstract

Base class for legend definition. More...

#include <legend.hpp>

Inheritance diagram for Legend:
ColormapLegend MultiEntryLegend

Public Member Functions

 Legend ()
 Default constructor for legend. More...
 
virtual ~Legend ()
 Virtual destructor. More...
 
virtual void plot (cairo_t *cairo, double x, double y)=0
 Plot legend at (x,y). More...
 
virtual void get_size (cairo_t *cairo, double &width, double &height)=0
 Get size of legend. More...
 

Detailed Description

Base class for legend definition.

Legend is an object that contains a key to the plot styles used in graphs. The key contains a sample of the plot style used and a corresponding text label.

The Colormap legend is a special case because in addition to the plot style, the plot z-range is shown in the legend.

The size of legend can be queried and the location can be set.

Constructor & Destructor Documentation

◆ Legend()

Legend::Legend ( )
inline

Default constructor for legend.

◆ ~Legend()

virtual Legend::~Legend ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ get_size()

virtual void Legend::get_size ( cairo_t *  cairo,
double &  width,
double &  height 
)
pure virtual

Get size of legend.

Implemented in ColormapLegend, and MultiEntryLegend.

◆ plot()

virtual void Legend::plot ( cairo_t *  cairo,
double  x,
double  y 
)
pure virtual

Plot legend at (x,y).

The point (x,y) is the lower left point of the entry.

Implemented in ColormapLegend, and MultiEntryLegend.


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


Reference manual for Ion Beam Simulator 1.0.6dev
Generated by Doxygen 1.9.1 on Thu Sep 11 2025 09:37:24.