lti::viewerBase3D::parameters Class Reference

The parameters for the class viewerBase3D. More...

#include <ltiViewerBase3D.h>

Inheritance diagram for lti::viewerBase3D::parameters:

[legend]

Collaboration diagram for lti::viewerBase3D::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
virtual parameters &	copy (const parameters &other)
virtual parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
std::string	saveName
rgbPixel	backgroundColor
rgbPixel	axisColor
point	windowSize
bool	axisColorFixed
draw3D< rgbPixel >::parameters	camParameters
dpoint3D	camTarget
double	camRadius

Detailed Description

The parameters for the class viewerBase3D.

The parameters for viewer classes have two functions:

First, the allow the user to indicate display options, like if he wants to show the system axes. This is much like the parameters functionality for all functors in the ltilib.

Second, the viewers have usually dialogs, that allow users to specify the desired options interactivelly (while displaying data). It is often usefull to get in that dialog some information about the image or data currently being displayed. This information is provided to the configuration dialog using some attributes in the parameters class. (this may be changed in the near future)

See also:: Creating new viewers for 3D data

Constructor & Destructor Documentation

lti::viewerBase3D::parameters::parameters ( )

default constructor

Reimplemented from lti::viewerBase::parameters.

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

lti::viewerBase3D::parameters::parameters ( const parameters & other )

copy constructor

Parameters:

other

the parameters object to be copied

lti::viewerBase3D::parameters::~parameters ( ) [virtual]

destructor

Reimplemented from lti::viewerBase::parameters.

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

Member Function Documentation

virtual functor::parameters* lti::viewerBase3D::parameters::clone ( ) const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::viewerBase::parameters.

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

virtual parameters& lti::viewerBase3D::parameters::copy ( const parameters & other ) [virtual]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:: a reference to this parameters object

const char* lti::viewerBase3D::parameters::getTypeName ( ) const [virtual]

returns name of this type

Reimplemented from lti::viewerBase::parameters.

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

virtual parameters& lti::viewerBase3D::parameters::operator= ( const parameters & other ) [virtual]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:: a reference to this parameters object

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

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

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

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

Member Data Documentation

rgbPixel lti::viewerBase3D::parameters::axisColor

Color of the axis, if the corresponding mode is specified for a fixed axis color.

Default: lti::White (lti::rgbPixel(255,255,255))

bool lti::viewerBase3D::parameters::axisColorFixed

If true, the given color for the axis will be used.

Otherwise gradients for red, green and blue will be used.

Default: true

rgbPixel lti::viewerBase3D::parameters::backgroundColor

Color of the background.

Default: lti::Black (lti::rgbPixel(0,0,0))

draw3D<rgbPixel>::parameters lti::viewerBase3D::parameters::camParameters

camera parameters for the 3D graphics.

Defaut values: camPos = computed from azimuth, elevation, camRadius and camTarget. azimuth = 45deg (45*Pi/180 radians) elevation = 60deg (60*Pi/180 radians) center = (0.5,0.5); perspective = 0.002; zoom = 0.5;

double lti::viewerBase3D::parameters::camRadius

Distance from the camera position to the camera origin.

Default value: 200

dpoint3D lti::viewerBase3D::parameters::camTarget

Point in the 3D space to which the camera always look at.

Default value: (128,128,128)

std::string lti::viewerBase3D::parameters::saveName

init filename (with path) for saving

Default: image.png

point lti::viewerBase3D::parameters::windowSize

Size of the viewer window.

Default: point(256,256)