VIBes output class. More...

#include <codac2_Figure2D_VIBes.h>

Inheritance diagram for codac2::Figure2D_VIBes:

[legend]

Collaboration diagram for codac2::Figure2D_VIBes:

[legend]

Public Member Functions
	Figure2D_VIBes (const Figure2D &fig)
	Creates a new Figure2D_VIBes object linked to a given figure.

	~Figure2D_VIBes ()
	Destructor for the Figure2D_VIBes object.

void	update_axes ()
	Updates the axes of the figure.

void	update_window_properties ()
	Updates the window properties of the figure.

void	center_viewbox (const Vector &c, const Vector &r)
	Centers the viewbox on a given point with a given radius.

void	draw_point (const Vector &c, const StyleProperties &s=StyleProperties())
	Draws a point on the figure.

void	draw_box (const IntervalVector &x, const StyleProperties &s=StyleProperties())
	Draws a box on the figure.

void	draw_circle (const Vector &c, double r, const StyleProperties &s=StyleProperties())
	Draws a circle on the figure.

void	draw_ring (const Vector &c, const Interval &r, const StyleProperties &s=StyleProperties())
	Draws a ring on the figure.

void	draw_polyline (const std::vector< Vector > &x, float tip_length, const StyleProperties &s=StyleProperties())
	Draws a polyline on the figure.

void	draw_polygon (const std::vector< Vector > &x, const StyleProperties &s=StyleProperties())
	Draws a polygone on the figure.

void	draw_pie (const Vector &c, const Interval &r, const Interval &theta, const StyleProperties &s=StyleProperties())
	Draws a pie on the figure.

void	draw_ellipse (const Vector &c, const Vector &ab, double theta, const StyleProperties &s=StyleProperties())
	Draws an ellipse on the figure.

void	draw_tank (const Vector &x, float size, const StyleProperties &s=StyleProperties())
	Draws a tank on the figure.

void	draw_AUV (const Vector &x, float size, const StyleProperties &s=StyleProperties())
	Draws an AUV on the figure.

void	draw_motor_boat (const Vector &x, float size, const StyleProperties &s=StyleProperties())
	Draws a motor boat on the figure.

Public Member Functions inherited from codac2::OutputFigure2D
	OutputFigure2D (const Figure2D &fig)
	Creates a new OutputFigure2D object linked to a given figure.

const Index &	i () const
	Getter for the horizontal Index.

const Index &	j () const
	Getter for the vertical Index.

Static Public Member Functions
static std::string	to_vibes_style (const StyleProperties &s)
	Converts a StyleProperties object to a VIBes style string.

Detailed Description

VIBes output class.

This class is used to manage the VIBes output. It is meant to be used with the VIBes server.

Constructor & Destructor Documentation

◆ Figure2D_VIBes()

codac2::Figure2D_VIBes::Figure2D_VIBes ( const Figure2D & fig )

Creates a new Figure2D_VIBes object linked to a given figure.

Parameters

fig	Figure2D to use

Member Function Documentation

◆ center_viewbox()

void codac2::Figure2D_VIBes::center_viewbox	(	const Vector &	c,
		const Vector &	r )

virtual

Centers the viewbox on a given point with a given radius.

Parameters

c	Center of the viewbox
r	Radius of the viewbox

Implements codac2::OutputFigure2D.

◆ draw_point()

void codac2::Figure2D_VIBes::draw_point	(	const Vector &	c,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a point on the figure.

Parameters

c	Coordinates of the point
s	Style of the point (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_box()

void codac2::Figure2D_VIBes::draw_box	(	const IntervalVector &	x,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a box on the figure.

Parameters

x	Box to draw
s	Style of the box (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_circle()

void codac2::Figure2D_VIBes::draw_circle	(	const Vector &	c,
		double	r,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a circle on the figure.

Parameters

c	Center of the circle
r	Radius of the circle
s	Style of the circle (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_ring()

void codac2::Figure2D_VIBes::draw_ring	(	const Vector &	c,
		const Interval &	r,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a ring on the figure.

Parameters

c	Center of the ring
r	Inner and outer radius of the ring
s	Style of the ring (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_polyline()

void codac2::Figure2D_VIBes::draw_polyline	(	const std::vector< Vector > &	x,
		float	tip_length,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a polyline on the figure.

Parameters

x	Vector of the points of the polyline
tip_length	Length of the tip of the arrow
s	Style of the polyline (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_polygon()

void codac2::Figure2D_VIBes::draw_polygon	(	const std::vector< Vector > &	x,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a polygone on the figure.

Parameters

x	Vector of the points of the polygone
s	Style of the polygone (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_pie()

void codac2::Figure2D_VIBes::draw_pie	(	const Vector &	c,
		const Interval &	r,
		const Interval &	theta,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a pie on the figure.

Parameters

c	Center of the pie
r	Inner and outer radius of the pie
theta	Start and end angle of the pie (in radians)
s	Style of the pie (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_ellipse()

void codac2::Figure2D_VIBes::draw_ellipse	(	const Vector &	c,
		const Vector &	ab,
		double	theta,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws an ellipse on the figure.

Parameters

c	Center of the ellipse
ab	Half-lengths of the ellipse
theta	Rotation angle of the ellipse (in radians)
s	Style of the ellipse (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_tank()

void codac2::Figure2D_VIBes::draw_tank	(	const Vector &	x,
		float	size,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a tank on the figure.

Parameters

x	Coordinates of the tank
size	Size of the tank
s	Style of the tank (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_AUV()

void codac2::Figure2D_VIBes::draw_AUV	(	const Vector &	x,
		float	size,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws an AUV on the figure.

Parameters

x	Coordinates of the AUV
size	Size of the AUV
s	Style of the AUV (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ draw_motor_boat()

void codac2::Figure2D_VIBes::draw_motor_boat	(	const Vector &	x,
		float	size,
		const StyleProperties &	s = StyleProperties() )

virtual

Draws a motor boat on the figure.

Parameters

x	Coordinates of the motor boat
size	Size of the motor boat
s	Style of the motor boat (edge color and fill color)

Implements codac2::Figure2DInterface.

◆ to_vibes_style()

static std::string codac2::Figure2D_VIBes::to_vibes_style ( const StyleProperties & s )

static

Converts a StyleProperties object to a VIBes style string.

Parameters

s	StyleProperties object to convert

Returns: VIBes style string

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

/home/simon/codac/src/graphics/3rd/vibes/codac2_Figure2D_VIBes.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Figure2D_VIBes()

Member Function Documentation

◆ center_viewbox()

◆ draw_point()

◆ draw_box()

◆ draw_circle()

◆ draw_ring()

◆ draw_polyline()

◆ draw_polygon()

◆ draw_pie()

◆ draw_ellipse()

◆ draw_tank()

◆ draw_AUV()

◆ draw_motor_boat()

◆ to_vibes_style()