CVR-Lib last update 20 Sep 2009

cvr::viewerBase::viewerBase::parameters Class Reference

Parameters of the cvr::viewerBase class. More...

#include <cvrViewerBase.h>

Inheritance diagram for cvr::viewerBase::viewerBase::parameters:

Inheritance graph
[legend]
Collaboration diagram for cvr::viewerBase::viewerBase::parameters:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 parameters ()
 parameters (const parameters &other)
virtual ~parameters ()
parameterscopy (const parameters &other)
virtual const std::string & name () const =0
virtual parametersclone () const =0
virtual parametersnewInstance () const =0
virtual bool write (ioHandler &handler, const bool complete=true) const
virtual bool read (ioHandler &handler, const bool complete=true)

Public Attributes

std::string title
interaction actionForConfig
ipoint position
ipoint size

Protected Member Functions

parametersoperator= (const parameters &other)


Detailed Description

Parameters of the cvr::viewerBase class.

There are parameters related with the GUI, for example which interaction type starts the config dialog, the position and size of the window, etc. There are other parameters related with the visualization of the data, which are defined in the functors that do the painting jobs for the viewers (e.g. cvr::viewer1DPainter.h, cvr::viewer2DPainter.h, cvr::viewer3DPainter.h). This functionality separation permits to use the painters without the GUI interfaces, in case the user wants to provide the same viewer abilities in his own GUI. The functors of the derived viewers will have parameters that inherit from this class and from the painters as well.

possible solution: the gui parameters follow, and they DO NOT inherit from functor. The other parameters can be found in the derived viewer classes so that their parameters can inherit from the current parameters AND from the painter functors' parameters.

This way, the viewers can make use of the functors using their own parameters, but a painter's parameters alone makes no sense here.


Constructor & Destructor Documentation

cvr::viewerBase::viewerBase::parameters::parameters (  ) 

Default constructor.

Reimplemented from cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

cvr::viewerBase::viewerBase::parameters::parameters ( const parameters other  ) 

Copy constructor.

Reimplemented from cvr::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

virtual cvr::viewerBase::viewerBase::parameters::~parameters (  )  [virtual]


Member Function Documentation

virtual parameters* cvr::viewerBase::viewerBase::parameters::clone (  )  const [pure virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::parametersManager::parametersManager::parameters.

Implemented in cvr::viewer2D::viewer2D::parameters.

parameters& cvr::viewerBase::viewerBase::parameters::copy ( const parameters other  ) 

virtual const std::string& cvr::viewerBase::viewerBase::parameters::name (  )  const [pure virtual]

Returns the name of this class.

Implements cvr::parametersManager::parametersManager::parameters.

Implemented in cvr::viewer2D::viewer2D::parameters.

virtual parameters* cvr::viewerBase::viewerBase::parameters::newInstance (  )  const [pure virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::parametersManager::parametersManager::parameters.

Implemented in cvr::viewer2D::viewer2D::parameters.

parameters& cvr::viewerBase::viewerBase::parameters::operator= ( const parameters other  )  [protected]

virtual bool cvr::viewerBase::viewerBase::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::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.

virtual bool cvr::viewerBase::viewerBase::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::parametersManager::parametersManager::parameters.

Reimplemented in cvr::viewer2D::viewer2D::parameters.


Member Data Documentation

interaction cvr::viewerBase::viewerBase::parameters::actionForConfig

What must happen in order to activate the configuration dialog.

Default value: {ButtonPressed,RightButton,NoModifier}

ipoint cvr::viewerBase::viewerBase::parameters::position

Position of the window.

Default value: (0,0)

ipoint cvr::viewerBase::viewerBase::parameters::size

Size of the window in pixels.

The size corresponds to the display area, which is a little bit smaller (depending on theme, window manager, etc.) than the whole size of the viewer window.

If you give negative values here, the size will be automatically set.

Default value: (-1,-1)

std::string cvr::viewerBase::viewerBase::parameters::title

Title for the main window.


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

Generated on Sun Sep 20 22:09:11 2009 for CVR-Lib by Doxygen 1.5.8