CRotate_interface.h File Reference

Interface for CRotate wrapper. More...

Go to the source code of this file.

Functions
CRotate	CRotate_Create (const CIDRS argIDRS, idrs_exception *pargException)
	Creates a new CRotate object.
void	CRotate_Rotate (const CRotate argCRotate, CImage argImage, IDRS_DOUBLE const dAngle, idrs_exception *pargException)
	Rotates the image clockwise by the supplied angle.
void	CRotate_Rotate2 (const CRotate argCRotate, CImage argImage, IDRS_DOUBLE const dAngle, const IDRS_COLOR *stBackgroundColor, idrs_exception *pargException)
	Rotates the image clockwise by the supplied angle.
void	CRotate_Rotate3 (const CRotate argCRotate, CPage argPage, IDRS_DOUBLE const dAngle, idrs_exception *pargException)
	Rotates the page clockwise by the given angle:
void	CRotate_CorrectOrientation (const CRotate argCRotate, CImage argImage, enum PageOrientation const evPageOrientation, idrs_exception *pargException)
	Rotates the image to correct its orientation according to the provided value. After the operation the image will be in straight position.
void	CRotate_CorrectOrientation2 (const CRotate argCRotate, CPage argPage, enum PageOrientation const evPageOrientation, idrs_exception *pargException)
	Rotates the page to correct its orientation according to the provided value.
void	CRotate_Destroy (CRotate argCRotate, idrs_exception *pargException)
	Destroys a CRotate handle.

Detailed Description

Interface for CRotate wrapper.

Function Documentation

CRotate_CorrectOrientation()

void CRotate_CorrectOrientation	(	const CRotate	argCRotate,
		CImage	argImage,
		enum PageOrientation const	evPageOrientation,
		idrs_exception *	pargException
	)

Rotates the image to correct its orientation according to the provided value. After the operation the image will be in straight position.

The PageOrientation to provide in argument should be according to the result of orientation detection feature.

Parameters

argCRotate	CRotate handle
argImage	The image to rotate.
evPageOrientation	The orientation to correct.
pargException	Pointer to exception structure that will be filled if an exception occurs

CRotate_CorrectOrientation2()

void CRotate_CorrectOrientation2	(	const CRotate	argCRotate,
		CPage	argPage,
		enum PageOrientation const	evPageOrientation,
		idrs_exception *	pargException
	)

Rotates the page to correct its orientation according to the provided value.

The PageOrientation to provide should be according to the result of orientation detection feature.

Parameters

argCRotate	CRotate handle
argPage	The page to rotate.
evPageOrientation	The orientation to correct.
pargException	Pointer to exception structure that will be filled if an exception occurs

CRotate_Create()

CRotate CRotate_Create	(	const CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Creates a new CRotate object.

Returns

The newly created CRotate object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to CImageOperation methods

CRotate_Destroy()

void CRotate_Destroy	(	CRotate	argCRotate,
		idrs_exception *	pargException
	)

Destroys a CRotate handle.

Parameters

argCRotate	CRotate handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CRotate_Rotate()

void CRotate_Rotate	(	const CRotate	argCRotate,
		CImage	argImage,
		IDRS_DOUBLE const	dAngle,
		idrs_exception *	pargException
	)

Rotates the image clockwise by the supplied angle.

Note

The rotation angle can be any value (integer or floating point) between -360 and 360

Parameters

argCRotate	CRotate handle
argImage	The image to rotate.
dAngle	The rotation angle in degrees.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

The background color used to fill the corners of the resulting image will be white (0xff, 0xff, 0xff)

CRotate_Rotate2()

void CRotate_Rotate2	(	const CRotate	argCRotate,
		CImage	argImage,
		IDRS_DOUBLE const	dAngle,
		const IDRS_COLOR *	stBackgroundColor,
		idrs_exception *	pargException
	)

Rotates the image clockwise by the supplied angle.

Note

The rotation angle can be any value (integer or floating point) between -360 and 360

Parameters

argCRotate	CRotate handle
argImage	The image to rotate.
dAngle	The rotation angle in degrees.
stBackgroundColor	The background color used to fill the corners of the resulting image (if needed)
pargException	Pointer to exception structure that will be filled if an exception occurs

CRotate_Rotate3()

void CRotate_Rotate3	(	const CRotate	argCRotate,
		CPage	argPage,
		IDRS_DOUBLE const	dAngle,
		idrs_exception *	pargException
	)

Rotates the page clockwise by the given angle:

• rotates the page's images
• rotates the zones of the pages.

Attention

The rotation doesn't keep the meaning of the zones.

Note

The rotation angle must be a multiple of 90° ( 90°, 180° or 270° ). Other values currently aren't supported yet.

Parameters

argCRotate	CRotate handle
argPage	The page to rotate.
dAngle	The rotation angle in degrees.
pargException	Pointer to exception structure that will be filled if an exception occurs