Figure and view management

VIBes drawings are performed on figures. These functions provide a way to create, save and manipulate figures. More...

Namespaces
	vibes

Figure management
void	vibes::newFigure (const std::string &figureName=std::string())
	Create a new figure named figureName.
void	vibes::clearFigure (const std::string &figureName=std::string())
	Clears the contents of the figure figureName, or the current figure if argument is given.
void	vibes::closeFigure (const std::string &figureName=std::string())
	Close the figure named figureName, or the current figure if no argument is given.
void	vibes::saveImage (const std::string &fileName, const std::string &figureName)
void	vibes::selectFigure (const std::string &figureName)
	Select figureName as the current figure. Drawing operations will then apply to figureName.

View settings
void	vibes::axisAuto (Params params=Params())
	Set axes limits to the bounding box of the drawing.
void	vibes::axisLimits (const double &x_lb, const double &x_ub, const double &y_lb, const double &y_ub, Params params=Params())
	Specify the rectangle to be displayed: Lower-left corner (x_lb, y_lb) and a upper-right corner (x_ub, y_ub).

Figure properties modification
void	vibes::setFigureProperty (const std::string &figureName, const std::string &key, const Value &value)
	Set the property key to the provided value for figure figureName. More...
void	vibes::setFigureProperty (const std::string &key, const Value &value)
	Set the property key to the provided value for current figure. More...
void	vibes::setFigureProperties (const std::string &figureName, const Params &properties)
	Assign the given properties to the figure figureName.
void	vibes::setFigureProperties (const Params &properties)
	Assign the given properties to the current figure.

Detailed Description

VIBes drawings are performed on figures. These functions provide a way to create, save and manipulate figures.

Function Documentation

void vibes::saveImage	(	const std::string &	fileName = std::string(),
		const std::string &	figureName = std::string()
	)

Export to fileName the contents of the figure figureName. If figureName is omitted, operation applies to current figure. If fileName is omitted, a "Save As" window will be displayed.

Definition at line 140 of file vibes.cpp.

void vibes::setFigureProperty ( const std::string &  figureName, const std::string &  key, const Value &  value  )

inline

Set the property key to the provided value for figure figureName.

Sets property key to the provided value for the figure named figureName.

Parameters

figureName	The name of the figure to alter
key	The name of the property to alter
value	The new value of the specified property

Definition at line 392 of file vibes.h.

void vibes::setFigureProperty ( const std::string &  key, const Value &  value  )

inline

Set the property key to the provided value for current figure.

Sets property key to the provided value for the current figure. This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 401 of file vibes.h.