codac::Figure Class Reference

Two-dimensional graphical item. More...

#include <codac_Figure.h>

Inheritance diagram for codac::Figure:

Public Member Functions
	Figure (const std::string &fig_name)
	Creates a Figure. More...
	~Figure ()
	Figure destructor.
int	x () const
	Returns the horizontal coordinate of this figure. More...
int	y () const
	Returns the vertical coordinate of this figure. More...
int	width () const
	Returns the width of this figure. More...
int	height () const
	Returns the height of this figure. More...
const std::string	name () const
	Returns the name of this figure. More...
const IntervalVector &	view_box () const
	Returns the real values displayed by this figure. More...
void	reset_view_box ()
	Reset the view box of this figure.
void	set_properties (int x, int y, int width, int height)
	Sets the properties (coordinates and dimensions) of this figure. More...

Static Protected Member Functions
static double	trunc_inf (double x)
	Returns a representable value of any double variable x More...
static const Interval	trunc_inf (const Interval &x)
	Returns a representable value of any interval \([x]\). More...
static const IntervalVector	trunc_inf (const IntervalVector &x)
	Returns a representable value of any interval vector \([\mathbf{x}]\). More...

Protected Attributes
const std::string	m_name
	figure name
int	m_height = 300
	figure properties
IntervalVector	m_view_box = IntervalVector(2, Interval::EMPTY_SET)
	view box

Detailed Description

Two-dimensional graphical item.

Constructor & Destructor Documentation

Figure()

codac::Figure::Figure

(

const std::string &

fig_name

)

Creates a Figure.

Parameters

fig_name

name of the figure as displayed in the window title

Member Function Documentation

x()

int codac::Figure::x

(

)

const

Returns the horizontal coordinate of this figure.

Returns

x-coordinate in pixels coordinates

y()

int codac::Figure::y

(

)

const

Returns the vertical coordinate of this figure.

Returns

y-coordinate in pixels coordinates

width()

int codac::Figure::width

(

)

const

Returns the width of this figure.

Returns

the width in pixels

height()

int codac::Figure::height

(

)

const

Returns the height of this figure.

Returns

the height in pixels

name()

const std::string codac::Figure::name

(

)

const

Returns the name of this figure.

Returns

the name

view_box()

const IntervalVector& codac::Figure::view_box

(

)

const

Returns the real values displayed by this figure.

Returns

the view box

set_properties()

void codac::Figure::set_properties	(	int	x,
		int	y,
		int	width,
		int	height
	)

Sets the properties (coordinates and dimensions) of this figure.

Parameters

x	horizontal coordinate (in pixels)
y	vertical coordinate (in pixels)
width	width value (in pixels)
height	height value (in pixels)

trunc_inf() [1/3]

static double codac::Figure::trunc_inf ( double  x )

staticprotected

Returns a representable value of any double variable x

A double variable may be defined as POS_INFINITY or NEG_INFINITY, which is not displayable. The function returns BOUNDED_INFINITY values in these cases.

Parameters

x	the value to be truncated if necessary

Returns

truncated value

trunc_inf() [2/3]

static const Interval codac::Figure::trunc_inf ( const Interval &  x )

staticprotected

Returns a representable value of any interval \([x]\).

A double bound may be defined as POS_INFINITY or NEG_INFINITY, which is not displayable. The function returns BOUNDED_INFINITY values in these cases.

Parameters

x	the interval for which the bounds will be truncated if necessary

Returns

truncated value

trunc_inf() [3/3]

static const IntervalVector codac::Figure::trunc_inf ( const IntervalVector &  x )

staticprotected

Returns a representable value of any interval vector \([\mathbf{x}]\).

A double bound may be defined as POS_INFINITY or NEG_INFINITY, which is not displayable. The function returns BOUNDED_INFINITY values in these cases.

Parameters

x	the interval vector for which the bounds will be truncated if necessary

Returns

truncated value

---

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

• /home/simon/codac/src/core/graphics/codac_Figure.h