In This Topic ▼

L_AnnGetScalarX

Summary

Gets the horizontal scaling factor that is applied to the annotation object. Typically, the scaling factors are applied to a root container so that the annotations will match the displayed image.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetScalarX(hObject, pdScalarX)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_DOUBLE *pdScalarX

Address of the variable to be updated with the horizontal scaling factor.

Returns

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

Comments

Offset values, which are set by the L_AnnSetOffsetX and L_AnnSetOffsetY functions, are applied after the scalar properties. For more information, refer to Low-Level Coordinate System for Annotations.

Before calling this function, you must declare a variable of data type L_DOUBLE. Then, pass the address of the variable in the pdScalarX parameter. This function will update the variable with the horizontal scaling factor.

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.

Example

This example displays the current annotation scalars as percentages.

L_INT AnnGetScalarXExample(HANNOBJECT hContainer /* Container annotation object */) 
{ 
   L_INT       nRet; 
   L_INT       XPercent, YPercent;  /* X and Y scale percentage */ 
   L_DOUBLE    XScalar, YScalar;    /* X and Y floating point scalars */ 
   L_TCHAR     szMessage[80];       /* Message buffer */ 
 
   /* Get the floating point scalars */ 
   nRet = L_AnnGetScalarX(hContainer, &XScalar); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_AnnGetScalarY(hContainer, &YScalar); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Convert the scalars to percentages */ 
   XPercent = (L_INT)(XScalar * 100); 
   YPercent = (L_INT)(YScalar * 100); 
 
   /* Display the percentages in a message */ 
   wsprintf (szMessage, TEXT("Notice: %d percent X and %d percent Y"), XPercent, YPercent); 
   _tprintf(_T("%s"), szMessage); 
 
   return SUCCESS; 
}