#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnSetSnapToGrid(hAutomation, uSnapToGridMode, pOptions)
Sets the state (on or off), the look, and the behavior of the annotation snap-to-grid.
Handle to the annotation automation object.
The constant that specifies the snap-to-grid state. Possible values are.
Value | Meaning |
---|---|
ANN_SNAPTOGRID_OFF | The snap-to-grid features is disabled. |
ANN_SNAPTOGRID_ON | The snap-to-grid features is enabled, and is visible in automation design mode |
Pointer to the ANNSNAPTOGRIDOPTIONS structure that LEADTOOLS uses to customize the look and behavior of the snap-to-grid.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
This function is used to enable or disable a snap-to-grid, and to customize its appearance and behavior.
The snap-to-grid feature is used in annotation automation design mode to allow the user to precisely draw, locate, and align annotation objects. When snap-to-grid is enabled by setting the uSnapToGridMode
parameter to ANN_SNAPTOGRID_ON, a grid pattern consisting of dots and lines is overlayed on the image. When creating annotations in design mode, each point snaps to the nearest grid point. This behavior holds for creating any annotation object EXCEPT the freehand annotation. When creating a freehand annotation, the individual points do NOT snap to the nearest grid point because this would adversely affect the behavior of the freehand. The snap-to-grid feature affects the moving of all annotations object types in design mode, in that the bounding box of the annotation object snaps to the nearest grid point.
To quickly enable to disable the snap-to-grid, pass the appropriate constant for uSnapToGridMode
parameter, and pass NULL for the pOptions
parameter.
To customize the look and behavior of the snap-to-grid, declare a variable of type ANNSNAPTOGRIDOPTIONS, and pass the address of this variable for pOptions. For a detailed explanation of the annotation snap-to-grid feature, see the documentation for ANNSNAPTOGRIDOPTIONS.
Required DLLs and Libraries
Win32, x64.
This sample
L_TCHAR* getLineStyleString(L_UINT uLineStyle)
{
TCHAR *pszLineStyle = TEXT("");
switch(uLineStyle)
{
case ANNLINE_SOLID:
pszLineStyle = TEXT("ANNLINE_SOLID");
break;
case ANNLINE_DASH:
pszLineStyle = TEXT("ANNLINE_DASH");
break;
case ANNLINE_DOT:
pszLineStyle = TEXT("ANNLINE_DOT");
break;
case ANNLINE_DASHDOT:
pszLineStyle = TEXT("ANNLINE_DASHDOT");
break;
case ANNLINE_DASHDOTDOT:
pszLineStyle = TEXT("ANNLINE_DASHDOTDOT");
break;
case ANNLINE_NULL:
pszLineStyle = TEXT("ANNLINE_NULL");
break;
}
return pszLineStyle;
}
L_VOID DisplaySnapToGrid(HANNOBJECT hAutomation, L_TCHAR *pszTitle)
{
L_TCHAR szMsg[200] = {0};
ANNSNAPTOGRIDOPTIONS options = {0};
L_UINT uSnapToGridMode = ANN_SNAPTOGRID_OFF;
options.uStructSize = sizeof(ANNSNAPTOGRIDOPTIONS);
options.uFlags = ANNSNAPTOGRID_ALL;
L_INT nRet = L_AnnGetSnapToGrid(hAutomation, &uSnapToGridMode, &options);
if (nRet == SUCCESS)
{
wsprintf(szMsg, TEXT("uSnapToGridMode[%s]\ncrGridColor[0x%x]\nuGridLength[%d]\nuLineSpacing[%d]\nuLineStyle[%s]\nbEnableSnap[%s]\nbShowGrid[%s]\nbAutoChangeGridLength[%s]"),
uSnapToGridMode == ANN_SNAPTOGRID_OFF ? TEXT("ANN_SNAPTOGRID_OFF") : TEXT("ANN_SNAPTOGRID_ON"),
options.crGridColor,
options.uGridLength,
options.uLineSpacing,
getLineStyleString(options.uLineStyle),
options.bEnableSnap ? TEXT("TRUE") : TEXT("FALSE"),
options.bShowGrid ? TEXT("TRUE") : TEXT("FALSE"),
options.bAutoChangeGridLength ? TEXT("TRUE") : TEXT("FALSE")
);
MessageBox(NULL, szMsg, pszTitle, MB_OK);
}
}
L_INT SampleAnnSetSnapToGridExample(HANNOBJECT hAutomation)
{
L_INT nRet = SUCCESS;
// Make sure that the snap-to-grid features is enabled
L_AnnSetOptions(hAutomation, OPTIONS_NEW_ALL | OPTIONS_NEW_SNAPTOGRID);
// Display current snap-to-grid settings
DisplaySnapToGrid(hAutomation, TEXT("Original Settings"));
// Change snap-to-grid to grid size of 10, lines every ten row of dots, solid red lines, and enable it
ANNSNAPTOGRIDOPTIONS options = {0};
options.uStructSize = sizeof(ANNSNAPTOGRIDOPTIONS);
options.uFlags = ANNSNAPTOGRID_ALL;
options.bAutoChangeGridLength = TRUE;
options.bEnableSnap = TRUE;
options.bShowGrid = TRUE;
options.crGridColor = RGB(255,0,0);
options.uGridLength = 10;
options.uLineSpacing = 10;
options.uLineStyle = ANNLINE_SOLID;
options.nReserved = 0;
nRet = L_AnnSetSnapToGrid(hAutomation, ANN_SNAPTOGRID_ON, &options);
if (nRet == SUCCESS)
{
DisplaySnapToGrid(hAutomation, TEXT("New Settings"));
}
return nRet;
}
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document