LImageViewerCell::AnnToRgn

Summary

Converts a selected annotation object inside a specific cell or sub-cell into a region, this region will be either set or combined with another existing region.

Syntax

L_INT LImageViewerCell::AnnToRgn(nSubCellIndex, uCombineMode, bDeleteAnn, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. This image contains the annotation object that the user chooses to convert into region. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

L_UINT uCombineMode

Value that specifies the action to apply on the existing bitmap region, if one is defined. For descriptions of the possible values, refer to Creating a Bitmap Region Inside the Image Viewer.

L_BOOL bDeleteAnn

Flag that indicates whether to delete the annotation object after converting it to a region. Possible values are:

L_UINT uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

Returns

Comments

The chosen sub-cell or cell must have a selected annotation in order to convert it into a region. If there is no selected annotation, the function will return ERROR_INV_PARAMETER.

This function works only on the closed shape annotation objects, such as rectangle, ellipse and Hilite.

If you have a cell with one image, you must set nSubCellIndex to zero.

Required DLLs and Libraries

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

See Also

Functions

• LImageViewer::Create
• LImageViewer::Destroy
• LImageViewerCell::SetAction
• LImageViewerCell::AddAction
• LImageViewerCell::GetSelectedAnnotationAttributes.

Topics

• Window Control/Image Viewer Functions: Annotations
• The Annotation Feature

Example

This function inverts a region inside the bitmap, we assumed that we have one cell, and there is a selected rectangular or elliptical annotation on it.

L_INT LImageViewer_AnnToRgnExample(LImageViewerCell& ImageViewerCell)  
{ 
   BITMAPHANDLE            Bitmap;  
   L_INT                   nRet;  
   DISPCONTAINERANNATTRIBS AnnAttrib;  
   LBitmap tmpBitmap; 
 
   memset(&AnnAttrib,0,sizeof(DISPCONTAINERANNATTRIBS)); 
 
   AnnAttrib.uStructSize = sizeof(DISPCONTAINERANNATTRIBS);  
 
   nRet = ImageViewerCell.GetSelectedAnnotationAttributes(0, &AnnAttrib, 0);  
   switch(AnnAttrib.uType)  
   { 
   case ANNOBJECT_RECT:  
   case ANNOBJECT_ELLIPSE:  
   case ANNOBJECT_HILITE:  
      break;  
   default:  
      return FAILURE;  
      break;  
   } 
 
   nRet = ImageViewerCell.AnnToRgn(-2, L_RGN_SET, TRUE, 0);  
   if (nRet != SUCCESS)  
      return nRet;  
 
   // Just apply the effect on the active sub-cell.  
   // this is done by setting the nSubCell parameter to -2.  
   nRet = ImageViewerCell.GetBitmapHandle(-2, &Bitmap, 0);  
   if (nRet != SUCCESS)  
      return nRet;  
 
   tmpBitmap.SetHandle(&Bitmap); 
   nRet = tmpBitmap.Invert(); 
   if (nRet != SUCCESS)  
      return nRet;  
 
   nRet = ImageViewerCell.SetBitmapHandle(-2, tmpBitmap.GetHandle(), FALSE, 0);  
   if (nRet != SUCCESS)  
      return nRet;  
 
   // Repaint the cell after the user is done with the changes.  
   //nRet = ImageViewerCell.RepaintCell(0, 0);  
   if (nRet != SUCCESS)  
      return nRet;  
 
   return SUCCESS;  
}