cvr::viewer2D::viewer2D::parameters Class Reference

There are parameters related with the GUI, for example which interaction configuration starts the config dialog, the position of the window, etc. More...

#include <cvrViewer2D.h>

Inheritance diagram for cvr::viewer2D::viewer2D::parameters:

[legend]

Collaboration diagram for cvr::viewer2D::viewer2D::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
std::string	filename

---

Detailed Description

There are parameters related with the GUI, for example which interaction configuration starts the config dialog, the position of the window, etc.

There are other parameters that configure options about the image painting, which depend on the lower classes. The former are inherited from viewerBase::parameters, the latter from viewer2DPainter::parameters.

---

Constructor & Destructor Documentation

cvr::viewer2D::viewer2D::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

cvr::viewer2D::viewer2D::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Reimplemented from cvr::viewerBase::viewerBase::parameters.

virtual cvr::viewer2D::viewer2D::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

---

Member Function Documentation

virtual parameters* cvr::viewer2D::viewer2D::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

parameters& cvr::viewer2D::viewer2D::parameters::copy

(

const parameters &

other

)

Copy data of "other" parameters.

Reimplemented from cvr::viewerBase::viewerBase::parameters.

virtual const std::string& cvr::viewer2D::viewer2D::parameters::name

(

)

const [virtual]

Returns the name of this class.

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

virtual parameters* cvr::viewer2D::viewer2D::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

parameters& cvr::viewer2D::viewer2D::parameters::operator=

(

const parameters &

other

)

Copy data of "other" parameters.

Reimplemented from cvr::viewerBase::viewerBase::parameters.

virtual bool cvr::viewer2D::viewer2D::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

Read the parameters from the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

virtual bool cvr::viewer2D::viewer2D::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

Write the parameters in the given ioHandler.

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from cvr::viewer2DPainter::viewer2DPainter::parameters.

---

Member Data Documentation

std::string cvr::viewer2D::viewer2D::parameters::filename

Filename used to save the images.

Default value: tux.png

---

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

• cvrViewer2D.h