lti::flipImage::parameters Class Reference

the parameters for the class flipImage More...

#include <ltiFlipImage.h>

Inheritance diagram for lti::flipImage::parameters:

[legend]

Collaboration diagram for lti::flipImage::parameters:

[legend]

List of all members.

Public Types
enum	eFlipDirection { None = 0, Horizontal, Vertical, Both }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
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
eFlipDirection	direction

---

Detailed Description

the parameters for the class flipImage

---

Member Enumeration Documentation

enum lti::flipImage::parameters::eFlipDirection

Flipping directions.

Enumerator:

None	Do not flip anything.
Horizontal	Horizontal flip means to map the top at the bottom and viceversa.
Vertical	Vertical flip means to map the right side into the left and viceversa.
Both	Turns image 180 degrees.

---

Constructor & Destructor Documentation

lti::flipImage::parameters::parameters

(

)

default constructor

Reimplemented from lti::modifier::parameters.

lti::flipImage::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::modifier::parameters.

lti::flipImage::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::flipImage::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::modifier::parameters.

parameters& lti::flipImage::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 lti::modifier::parameters.

const char* lti::flipImage::parameters::getTypeName

(

)

const [virtual]

returns name of this type

Reimplemented from lti::modifier::parameters.

parameters& lti::flipImage::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

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

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

---

Member Data Documentation

eFlipDirection lti::flipImage::parameters::direction

Axis along which the image will be flipped.

Default value: Horizontal

---

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

• ltiFlipImage.h