cvr::matrixTransform< I >::matrixTransform::parameters Class Reference

The parameters for the class matrixTransform<T>. More...

#include <cvrMatrixTransform.h>

Inheritance diagram for cvr::matrixTransform< I >::matrixTransform::parameters:

[legend]

Collaboration diagram for cvr::matrixTransform< I >::matrixTransform::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~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
fmatrix	transformation

---

Detailed Description

template<class I>
class cvr::matrixTransform< I >::parameters

The parameters for the class matrixTransform<T>.

---

Constructor & Destructor Documentation

template<class I>

cvr::matrixTransform< I >::matrixTransform::parameters::parameters

(

)

Default constructor.

Reimplemented from cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

cvr::matrixTransform< I >::matrixTransform::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

cvr::matrixTransform< I >::matrixTransform::parameters::~parameters

(

)

[virtual]

Destructor.

Reimplemented from cvr::geometricTransform< I >::geometricTransform::parameters.

---

Member Function Documentation

template<class I>

virtual parameters* cvr::matrixTransform< I >::matrixTransform::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

parameters& cvr::matrixTransform< I >::matrixTransform::parameters::copy

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

virtual const std::string& cvr::matrixTransform< I >::matrixTransform::parameters::name

(

)

const [virtual]

Returns the complete name of the parameters class.

Reimplemented from cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

virtual parameters* cvr::matrixTransform< I >::matrixTransform::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

parameters& cvr::matrixTransform< I >::matrixTransform::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from cvr::geometricTransform< I >::geometricTransform::parameters.

template<class I>

virtual bool cvr::matrixTransform< I >::matrixTransform::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::geometricTransform< I >::geometricTransform::parameters.

template<class I>

virtual bool cvr::matrixTransform< I >::matrixTransform::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::geometricTransform< I >::geometricTransform::parameters.

---

Member Data Documentation

template<class I>

fmatrix cvr::matrixTransform< I >::matrixTransform::parameters::transformation

Transformation matrix.

The transformation matrix have to be invertible, and need to have size 2x2, 2x3, 3x3, 4x4 or 4x3.

Default value: 2x2 identity matrix

---

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

• cvrMatrixTransform.h