LAnnRuler::GetDistance

Show in webframe

#include "ltwrappr.h"

virtual L_INT LAnnRuler::GetDistance(pdDistance)

L_DOUBLE *pdDistance;

/* address of the variable that will be updated with the distance of a ruler object */

Gets the distance of the annotation object in the object's unit of measurement, set by LAnnRuler::SetUnit.

Parameter	Description
pdDistance	Address of the variable to be updated with the distance of the ruler object. For objects having only one ruler, this variable will be updated with the length. For cross products, which have two rulers, this variable will be updated with the length of the primary ruler.

Returns

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

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, LAnnAutomation::GetTicMarkLength, LAnnAutomation::SetTicMarkLength
Topics:	Annotation Functions: Working with the Toolbar
	Implementing Annotations
	Automated User Interface for Annotations
	Using Rulers in Annotation Objects

Example

L_INT LAnnRuler_GetDistanceExample(HWND hWnd)
{
   LBitmap MyBitmap;
   RECT rect;
   LAnnRuler MyAnnRuler;
   ANNPOINT MyPts[2] = { 40,40,
                         140,40,
                       };
   pANNPOINT pMyPts = MyPts;
   MyAnnRuler.SetPoints(pMyPts, 2);
   L_UINT uShowFlags;
   MyAnnRuler.GetShowFlags(&uShowFlags);
   MyAnnRuler.SetShowFlags(ANNSHOW_LENGTH,0);
   //Set Ruler properties
   MyAnnRuler.SetVisible(TRUE);
   MyAnnRuler.GetBoundingRect(&rect);
   L_DOUBLE dDist=0;
   MyAnnRuler.GetDistance(&dDist);
   //Draw the annotation
   HDC hDC = ::GetDC(hWnd);
   MyAnnRuler.Draw(hDC,&rect);
   ::ReleaseDC(hWnd, hDC); 
   return SUCCESS;
}