LAnnPolyRuler::GetGaugeLength

#include "ltwrappr.h"

virtual L_DOUBLE LAnnPolyRuler::GetGaugeLength()

Gets the length of the gauge (the perpendicular lines at the ends of the Polyruler object).

Returns

The object's gauge length.

Comments

The gauge length property applies only to Automation, PolyRuler, and Ruler objects. Refer to Annotation Automation Object.

Length is expressed in pixels, not in points. The length is for the whole line, not just from the end point of the ruler to the end point of the gauge - it is from one end of the gauge to the other end of the gauge.

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:	LAnnPolyRuler::SetUnit, LAnnPolyRuler::GetUnit, LAnnPolyRuler::GetDistance, LAnnPolyRuler::SetGaugeLength, LAnnPolyRuler::GetTicMarkLength, LAnnPolyRuler::SetTicMarkLength, LAnnotation::CalibrateRuler, Class Members
Topics:	Annotation Functions: Working with the Toolbar
	Implementing Annotations
	Automated User Interface for Annotations
	Using Rulers in Annotation Objects
	Key Annotation Features
	Calibrating Annotation Ruler Objects

Example

L_INT LAnnPolyRuler_GetGaugeLengthExample(LAnnPolyRuler *pLPolyRuler) 
{
   L_INT nRet;
   L_DOUBLE dLength;
   /* if gauge length setting for the PolyRuler object 
   is larger than 5 pixels, then make it 5 pixels. */
   dLength = pLPolyRuler->GetGaugeLength();
   if(dLength > 5.0f)
   {
      nRet = pLPolyRuler->SetGaugeLength( 5.0f, 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}