LEADTOOLS (Leadtools assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
AddRoundRectangleToRegion Method
See Also 
Leadtools Namespace > RasterImage Class : AddRoundRectangleToRegion Method



xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.
rc
A LeadRect that specifies the bounding rectangle of the region.
ellipse
Specifies the width and height of the ellipse that describes the arc of the rounded corners.
combineMode
The action to take regarding the existing image region, if one is defined.
xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.
rc
A LeadRect that specifies the bounding rectangle of the region.
ellipse
Specifies the width and height of the ellipse that describes the arc of the rounded corners.
combineMode
The action to take regarding the existing image region, if one is defined.
Creates or updates the image region by adding a rounded rectangular region.

Syntax

Visual Basic (Declaration) 
Public Sub AddRoundRectangleToRegion( _
   ByVal xform As RasterRegionXForm, _
   ByVal rc As LeadRect, _
   ByVal ellipse As LeadSize, _
   ByVal combineMode As RasterRegionCombineMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim rc As LeadRect
Dim ellipse As LeadSize
Dim combineMode As RasterRegionCombineMode
 
instance.AddRoundRectangleToRegion(xform, rc, ellipse, combineMode)
C# 
public void AddRoundRectangleToRegion( 
   RasterRegionXForm xform,
   LeadRect rc,
   LeadSize ellipse,
   RasterRegionCombineMode combineMode
)
C++/CLI 
public:
void AddRoundRectangleToRegion( 
   RasterRegionXForm^ xform,
   LeadRect rc,
   LeadSize ellipse,
   RasterRegionCombineMode combineMode
) 

Parameters

xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null (Nothing in Visual Basic) in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.
rc
A LeadRect that specifies the bounding rectangle of the region.
ellipse
Specifies the width and height of the ellipse that describes the arc of the rounded corners.
combineMode
The action to take regarding the existing image region, if one is defined.

Example

This example will load an image, adds a round rectangle region to it, run the InvertCommand to show the affected area before saving the image back to disk.

Visual BasicCopy Code
Public Sub AddRoundRectangleToRegionExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
      Dim destFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddRoundRectangleToRegion.bmp")

      ' Load the image
      Dim image As RasterImage = codecs.Load(srcFileName)

      ' Add a round rectangle region

      Dim xform As RasterRegionXForm = New RasterRegionXForm()
      xform.ViewPerspective = RasterViewPerspective.TopLeft
      xform.XOffset = 0
      xform.YOffset = 0
      xform.XScalarDenominator = 1
      xform.XScalarNumerator = 1
      xform.YScalarDenominator = 1
      xform.YScalarNumerator = 1

      Dim rc As LeadRect = New LeadRect(image.ImageWidth \ 4, image.ImageHeight \ 4, image.ImageWidth \ 3, image.ImageHeight \ 3)
      Dim sz As LeadSize = New LeadSize(rc.Width \ 4, rc.Height \ 4)
      image.AddRoundRectangleToRegion(xform, rc, sz, RasterRegionCombineMode.Set)

      ' Draw something on the image
      Dim command As InvertCommand = New InvertCommand()
      command.Run(image)

      ' Save the image
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24)

      image.Dispose()
      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
C#Copy Code
public void AddRoundRectangleToRegionExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
      string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_AddRoundRectangleToRegion.bmp");

      // Load the image
      RasterImage image = codecs.Load(srcFileName);

      // Add a round rectangle region

      RasterRegionXForm xform = new RasterRegionXForm();
      xform.ViewPerspective = RasterViewPerspective.TopLeft;
      xform.XOffset = 0;
      xform.YOffset = 0;
      xform.XScalarDenominator = 1;
      xform.XScalarNumerator = 1;
      xform.YScalarDenominator = 1;
      xform.YScalarNumerator = 1;

      LeadRect rc = new LeadRect(image.ImageWidth / 4, image.ImageHeight / 4, image.ImageWidth / 3, image.ImageHeight / 3);
      LeadSize sz = new LeadSize(rc.Width / 4, rc.Height / 4);
      image.AddRoundRectangleToRegion(xform, rc, sz, RasterRegionCombineMode.Set);

      // Draw something on the image
      InvertCommand command = new InvertCommand();
      command.Run(image);

      // Save the image
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, 24);

      image.Dispose();
      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
SilverlightCSharpCopy Code
SilverlightVBCopy Code

Remarks

To update an existing region, you specify how the new region is to be combined with the existing one using the combineMode parameter. For more information, refer to RasterRegionCombineMode.

For more information, refer to Creating a Region.

For more information, refer to Saving A Region.

For more information, refer to Working with the Existing Region.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only), Windows Phone 7

See Also