lti::viewerBase3D Class Reference

This is the base class for all viewer classes which show 3D data. More...

#include <ltiViewerBase3D.h>

Inheritance diagram for lti::viewerBase3D:

[legend]

Collaboration diagram for lti::viewerBase3D:

[legend]

List of all members.

Classes
class	configDialog
	GTK Widget for the configuration dialog of the histogram viewer. More...
class	mainWindow
	Widget for the main class of the histogram viewer. More...
class	parameters
	The parameters for the class viewerBase3D. More...
Public Member Functions
	viewerBase3D (bool createDefaultParams=true)
	viewerBase3D (const viewerBase3D &other)
	viewerBase3D (const std::string &title)
virtual	~viewerBase3D ()
virtual const char *	getTypeName () const
viewerBase3D &	copy (const viewerBase3D &other)
viewerBase3D &	operator= (const viewerBase3D &other)
virtual viewerBase *	clone () const
const parameters &	getParameters () const
parameters &	getParameters ()
virtual bool	show (const image &data)
virtual bool	show (const channel8 &data)
virtual bool	show (const channel &data)
virtual bool	show (const matrix< float > &data)
virtual bool	show (const vector< double > &data)
virtual bool	show (const vector< float > &data)
virtual bool	show (const vector< int > &data)
virtual bool	show (const matrix< double > &data)
virtual bool	show (const matrix< int > &data)
virtual bool	hide ()
virtual bool	snapshot (const std::string &filename) const
virtual bool	setParameters (const viewerBase::parameters &param)
Protected Member Functions
virtual bool	show ()
virtual mainWindow *	getNewMainWindow () const
virtual bool	ensureMainWindowInstance ()
Protected Attributes
mainWindow *	wnd

---

Detailed Description

This is the base class for all viewer classes which show 3D data.

It supports the manipulation of the 3D camera parameters using the mouse, and provides all necessary interfaces that simplify subclasses accessing configuration dialogs.

See also:

Creating new viewers for 3D data

---

Constructor & Destructor Documentation

lti::viewerBase3D::viewerBase3D

(

bool

createDefaultParams = true

)

default constructor

lti::viewerBase3D::viewerBase3D

(

const viewerBase3D &

other

)

copy constructor

Parameters:

other

the object to be copied

lti::viewerBase3D::viewerBase3D

(

const std::string &

title

)

constructor with windows title

virtual lti::viewerBase3D::~viewerBase3D

(

)

[virtual]

destructor

---

Member Function Documentation

virtual viewerBase* lti::viewerBase3D::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::viewerBase.

Reimplemented in lti::histogramViewer, and lti::scene3DViewer.

viewerBase3D& lti::viewerBase3D::copy

(

const viewerBase3D &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer, and lti::scene3DViewer.

virtual bool lti::viewerBase3D::ensureMainWindowInstance

(

)

[protected, virtual]

ensure that a mainWindow instance exist.

You usually do not require to reimplement this method.

Returns:

true if everything is ok, false, if the mainWindow do not exist and it could not be created.

virtual mainWindow* lti::viewerBase3D::getNewMainWindow

(

)

const [protected, virtual]

return a new instance of the mainWindow class.

This class must be reimplemented in order to get the proper class instance.

Reimplemented in lti::histogramViewer, and lti::scene3DViewer.

parameters& lti::viewerBase3D::getParameters

(

)

returns used parameters

Reimplemented from lti::viewerBase.

const parameters& lti::viewerBase3D::getParameters

(

)

const

returns used parameters

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer, and lti::scene3DViewer.

virtual const char* lti::viewerBase3D::getTypeName

(

)

const [virtual]

returns the name of this type ("viewerBase3D")

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer, and lti::scene3DViewer.

virtual bool lti::viewerBase3D::hide

(

)

[inline, virtual]

hides the display window

Returns:

true if successful, false otherwise.

Implements lti::viewerBase.

viewerBase3D& lti::viewerBase3D::operator=

(

const viewerBase3D &

other

)

alias for copy member

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer, and lti::scene3DViewer.

virtual bool lti::viewerBase3D::setParameters

(

const viewerBase::parameters &

param

)

[virtual]

set the parameters to be used

Reimplemented from lti::viewerBase.

virtual bool lti::viewerBase3D::show

(

)

[protected, virtual]

shows the data.

The tasks done by this method are:

• ensure the existence of a mainWindow instance.
• indicate the mainWindow to draw the new data.

  Returns:

  true if successful, false otherwise.

virtual bool lti::viewerBase3D::show

(

const matrix< int > &

data

)

[inline, virtual]

shows a matrix of integers as a channel

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const matrix< double > &

data

)

[inline, virtual]

shows a matrix of doubles as a channel

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const vector< int > &

data

)

[inline, virtual]

shows a vector of double

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const vector< float > &

data

)

[inline, virtual]

shows a vector of double

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const vector< double > &

data

)

[inline, virtual]

shows a vector of double

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const matrix< float > &

data

)

[inline, virtual]

shows a channel or matrix of float

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const channel &

data

)

[inline, virtual]

shows a channel or matrix of float

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const channel8 &

data

)

[inline, virtual]

shows a 8-bit channel

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Reimplemented from lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::show

(

const image &

data

)

[inline, virtual]

shows a color image.

Parameters:

data

the object to be shown.

Returns:

true if successful, false otherwise.

Implements lti::viewerBase.

Reimplemented in lti::histogramViewer.

virtual bool lti::viewerBase3D::snapshot

(

const std::string &

filename

)

const [virtual]

take a snapshot of the current visualized image.

The image being shown will be saved in a file with the given name. All data types supported by lti::saveImage functor will be accepted.

---

Member Data Documentation

mainWindow* lti::viewerBase3D::wnd [protected]

the main window.

(have to defined after inhert the mainWindow class)

---

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

• ltiViewerBase3D.h