Celartem::ImageUtils::RotateAndFlipParam Struct Reference

#include <pxl_imageparam.h>

Inheritance diagram for Celartem::ImageUtils::RotateAndFlipParam:

[legend]

List of all members.

Public Member Functions
	RotateAndFlipParam (ImageUtils::FourAngles inAngle=faAngle0, bool inFlipVertical=false, bool inFlipHorizontal=false)
bool	rotationIsInClockwise () const
void	rotateLeft ()
void	rotateRight ()
void	rotate90degree ()
void	rotate270degree ()
void	flipVertically ()
void	flipHorizontally ()
Public Attributes
ImageUtils::FourAngles	angle
	Specifies the angle of the output image.
bool	flipVertical
	Whether flips the image vertically after the rotation.
bool	flipHorizontal
	Whether flips the image horizontally after the rotation.

---

Detailed Description

This structure is used to control the behavior of RotateAndFlip.
The rotation is usually in conter-clockwise direction. Since the vertical/horizontal flip is done after rotation, the rotation is done in clockwise direction if only one of vertical or horizontal rotation is enabled.
rotateLeft, rotateRight method is useful when you want to rotate the image by a direction rather than a degree.

See also:

rotateLeft, rotateRight

Definition at line 513 of file pxl_imageparam.h.

---

Constructor & Destructor Documentation

Celartem::ImageUtils::RotateAndFlipParam::RotateAndFlipParam	(	ImageUtils::FourAngles	inAngle = faAngle0,
		bool	inFlipVertical = false,
		bool	inFlipHorizontal = false
	)			[inline]

This constructor initializes the structure with the specified parameters.

Parameters:

	inAngle	Specifies the angle of the output image.
	inFlipVertical	Whether flips the image vertically after the rotation.
	inFlipHorizontal	Whether flips the image horizontally after the rotation.

Definition at line 529 of file pxl_imageparam.h.

---

Member Function Documentation

bool Celartem::ImageUtils::RotateAndFlipParam::rotationIsInClockwise

(

)

const [inline]

This function determines whether the rotation is in clockwise direction or not.

Returns:

true if the rotation is in clockwise direction; otherwise false.

Definition at line 546 of file pxl_imageparam.h.

Referenced by rotateLeft(), and rotateRight().

void Celartem::ImageUtils::RotateAndFlipParam::rotateLeft

(

)

[inline]

This function rotates the angle to left.

See also:

rotateRight

Definition at line 557 of file pxl_imageparam.h.

void Celartem::ImageUtils::RotateAndFlipParam::rotateRight

(

)

[inline]

This function rotates the angle to right.

Definition at line 568 of file pxl_imageparam.h.

void Celartem::ImageUtils::RotateAndFlipParam::rotate90degree

(

)

[inline]

This function rotates 90 degree.

See also:

rotate270degree

Definition at line 580 of file pxl_imageparam.h.

Referenced by rotateLeft(), and rotateRight().

void Celartem::ImageUtils::RotateAndFlipParam::rotate270degree

(

)

[inline]

This function rotates -90 (270) degree.

See also:

rotate90degree

Definition at line 589 of file pxl_imageparam.h.

Referenced by rotateLeft(), and rotateRight().

void Celartem::ImageUtils::RotateAndFlipParam::flipVertically

(

)

[inline]

This function flips vertically.

See also:

flipHorizontally

Definition at line 598 of file pxl_imageparam.h.

void Celartem::ImageUtils::RotateAndFlipParam::flipHorizontally

(

)

[inline]

This function flips Horizontally.

See also:

flipVertically

Definition at line 607 of file pxl_imageparam.h.

---

Member Data Documentation

ImageUtils::FourAngles Celartem::ImageUtils::RotateAndFlipParam::angle

Specifies the angle of the output image.

Definition at line 515 of file pxl_imageparam.h.

Referenced by rotate270degree(), and rotate90degree().

bool Celartem::ImageUtils::RotateAndFlipParam::flipVertical

Whether flips the image vertically after the rotation.

Definition at line 516 of file pxl_imageparam.h.

Referenced by flipVertically(), and rotationIsInClockwise().

bool Celartem::ImageUtils::RotateAndFlipParam::flipHorizontal

Whether flips the image horizontally after the rotation.

Definition at line 517 of file pxl_imageparam.h.

Referenced by flipHorizontally(), and rotationIsInClockwise().

---

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

• pxl_imageparam.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:35 2008.