Collapse All Expand All

LAnnRectangle::GetRotateAngle

#include "ltwrappr.h"

virtual L_INT LAnnRectangle::GetRotateAngle(pdAngle)

L_DOUBLE *pdAngle;

/* pointer to a double that returns the rotate angle */

Gets the rotation angle for an annotation object.

Parameter	Description
pdAngle	Pointer to a double variable to be updated with the rotation angle.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Call this function to get the rotation angle for a particular annotation object.

The angle is in radians, and uses the following convention.

The possible range of rotate values is (-Pi) ... (Pi)

A rotation in the clockwise direction is considered a positive rotation.

A rotation in the counter-clockwise direction is considered a negative rotation.

For example, if a rectangle is rotated 90 degrees in the counter clockwise direction, this function will get (-PI/2) for the rotation angle. If a rectangle is rotated 90 degrees in the clockwise direction, this function will get PI/2 for the rotation angle. If a rectangle is rotated 270 degrees in the counter clockwise direction, this is equivalent to 90 degrees in the clockwise direction so the rotation value returned is PI/2.

Required DLLs and Libraries

LTANN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:	Class Members
Topics:	Annotation Functions: Implementing Custom Annotations

Example

// This examples displays the rotation angle of the Rectangle annotation object in radians and degrees

L_INT LAnnRectangle_GetRotateAngleExample(LAnnRectangle * pLRectangle) 
{
        L_INT nRet;
   L_DOUBLE dAngle; 
   L_TCHAR   szMsg[200]; 
   nRet = nRet = pLRectangle->GetRotateAngle(&dAngle); 
        if(nRet != SUCCESS)
                return nRet;
   if (nRet == SUCCESS) 
   {
      wsprintf(szMsg, TEXT("Angle of rotation:  Radians[%lf]  Degrees[%f]\n"),
                                        dAngle, 
                                        dAngle *180 / 3.1415926535
                                        ); 
      MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
   }
        else
                return nRet;
        return SUCCESS;
}