lti::viewerBase::parameters Class Reference

Base class for all lti parameter objects. More...

#include <ltiViewerBase.h>

Inheritance diagram for lti::viewerBase::parameters:

[legend]

Collaboration diagram for lti::viewerBase::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 functor::parameters *	clone () const
const char *	getTypeName () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
std::string	title

---

Detailed Description

Base class for all lti parameter objects.

---

Constructor & Destructor Documentation

lti::viewerBase::parameters::parameters

(

)

default constructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, lti::viewer::parameters, and lti::viewerBase3D::parameters.

lti::viewerBase::parameters::parameters

(

const parameters &

other

)

copy constructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, and lti::viewer::parameters.

virtual lti::viewerBase::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, lti::viewer::parameters, and lti::viewerBase3D::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::viewerBase::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters.

Implements lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, lti::viewer::parameters, and lti::viewerBase3D::parameters.

parameters& lti::viewerBase::parameters::copy

(

const parameters &

other

)

copy data of "other" parameters

Reimplemented from lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, and lti::viewer::parameters.

const char* lti::viewerBase::parameters::getTypeName

(

)

const [virtual]

return the name of this type

Reimplemented from lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, lti::viewer::parameters, and lti::viewerBase3D::parameters.

parameters& lti::viewerBase::parameters::operator=

(

const parameters &

other

)

copy data of "other" parameters

Reimplemented from lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, and lti::viewer::parameters.

virtual bool lti::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 lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, lti::viewer::parameters, and lti::viewerBase3D::parameters.

virtual bool lti::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 lti::functor::parameters.

Reimplemented in lti::externViewer::parameters, lti::histogramViewer::parameters, lti::scene3DViewer::parameters, lti::viewer::parameters, and lti::viewerBase3D::parameters.

---

Member Data Documentation

std::string lti::viewerBase::parameters::title

title of the viewer window.

Default value: value returned by getTypeName()

---

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

• ltiViewerBase.h