EqPotGraph Class Reference

Equipotential line plot. More...

#include <eqpotgraph.hpp>

Inheritance diagram for EqPotGraph:

Public Member Functions
	EqPotGraph (const MeshScalarField &epot, const Geometry &geom)
	Constructor for equipotential line plot. More...
virtual	~EqPotGraph ()
	Destructor,. More...
void	disable_cache (void)
	Disable internal cache. More...
void	set_eqlines_manual (const std::vector< double > &pot)
	Add manual equipotential lines to be plotted at specified potentials. More...
void	set_eqlines_auto (size_t N)
	Set N automatic equipotential lines to be plotted between minimum potential and maximum potentials. More...
virtual void	plot (cairo_t *cairo, const Coordmapper *cm, const double range[4])
	Plot graph with cairo. More...
virtual void	plot_sample (cairo_t *cairo, double x, double y, double width, double height)
	Plot sample for legend. More...
virtual void	get_bbox (double bbox[4])
	Get bounding box of drawable. More...
Public Member Functions inherited from Graph3D
	Graph3D (const Mesh &mesh)
	Constructor. More...
virtual	~Graph3D ()
	Virtual destructor. More...
void	set_view (view_e view, int level)
	Set the view of 3D drawable. More...
Public Member Functions inherited from Graph
virtual	~Graph ()
	Virtual destructor. More...

Additional Inherited Members
Protected Attributes inherited from Graph3D
const Mesh &	_mesh
	Mesh of simulation. More...
view_e	_view
	Geometry view direction. More...
int	_vb [3]
	Coordinate index for first, second and third axes. More...
int	_level
	Level of slice in mesh units. More...
double	_level_si
	Level in meters. More...

Detailed Description

Equipotential line plot.

Class for constructing and drawing equipotential line plots.

Constructor & Destructor Documentation

EqPotGraph()

EqPotGraph::EqPotGraph	(	const MeshScalarField &	epot,
		const Geometry &	geom
	)

Constructor for equipotential line plot.

Makes a plot object for plotting equipotential data from scalarfield field in geometry g.

~EqPotGraph()

EqPotGraph::~EqPotGraph ( )

virtual

Destructor,.

Member Function Documentation

disable_cache()

void EqPotGraph::disable_cache

(

void

)

Disable internal cache.

Makes equipotential lines to be calculated at every plot().

get_bbox()

void EqPotGraph::get_bbox ( double  bbox[4] )

virtual

Get bounding box of drawable.

Returns the bounding box of the drawable in array bbox in order xmin, ymin, xmax, ymax.

Implements Graph3D.

plot()

void EqPotGraph::plot ( cairo_t *  cairo, const Coordmapper *  cm, const double  range[4]  )

virtual

Plot graph with cairo.

Plot the graph using cairo and coordinate mapper cm. The visible range of plot is given in array range in order xmin, ymin, xmax, ymax. The graph should be able to handle any range values. Also min > max.

Called by Frame during drawing.

Implements Graph3D.

plot_sample()

void EqPotGraph::plot_sample ( cairo_t *  cairo, double  x, double  y, double  width, double  height  )

virtual

Plot sample for legend.

Plot graph sample for legend at cairo coordinates (x,y).

Implements Graph3D.

set_eqlines_auto()

void EqPotGraph::set_eqlines_auto

(

size_t

N

)

Set N automatic equipotential lines to be plotted between minimum potential and maximum potentials.

set_eqlines_manual()

void EqPotGraph::set_eqlines_manual

(

const std::vector< double > &

pot

)

Add manual equipotential lines to be plotted at specified potentials.

---

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

• eqpotgraph.hpp
• eqpotgraph.cpp