AddRectangleToRegion Method

Creates or updates the image region by adding a rectangular region.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public void AddRectangleToRegion( 
   RasterRegionXForm xform,
   LeadRect rc,
   RasterRegionCombineMode combineMode
)

'Declaration
 
Public Sub AddRectangleToRegion( _
   ByVal xform As RasterRegionXForm, _
   ByVal rc As LeadRect, _
   ByVal combineMode As RasterRegionCombineMode _
)

'Usage
 
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim rc As LeadRect
Dim combineMode As RasterRegionCombineMode
 
instance.AddRectangleToRegion(xform, rc, combineMode)

public void AddRectangleToRegion( 
   RasterRegionXForm xform,
   LeadRect rc,
   RasterRegionCombineMode combineMode
)

 function Leadtools.RasterImage.AddRectangleToRegion( 
   xform ,
   rc ,
   combineMode 
)

public:
void AddRectangleToRegion( 
   RasterRegionXForm^ xform,
   LeadRect rc,
   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 region.
combineMode: The action to take regarding the existing image region, if one is defined.

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.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub AddRectangleToRegionExample()
      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_AddRectangleToRegion.bmp")

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

      ' Add a 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)
      image.AddRectangleToRegion(xform, rc, 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

public void AddRectangleToRegionExample()
   {
      RasterCodecs codecs = new RasterCodecs();

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

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

      // Add a 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);
      image.AddRectangleToRegion(xform, rc, 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";
}

RasterImageExamples.prototype.AddRectangleToRegionExample = function ( )
{
   Tools.SetLicense ( );
   with ( Leadtools ) 
   {
      with ( Leadtools.Codecs )
      {
         var codecs = new RasterCodecs();

         var srcFileName = "Assets\\Image1.cmp";
         var destFileName = "Image1_AddRectangleToRegion.bmp";
         var image ;
         // Load the image
         return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
            return codecs.loadAsync(LeadStreamFactory.create(loadFile))
         })
            .then(function (img) {
               image = img;

               // Add a rectangle region

               var 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;

               var rc = LeadRectHelper.create(image.imageWidth / 4, image.imageHeight / 4, image.imageWidth / 3, image.imageHeight / 3);
               image.addRectangleToRegion(xform, rc, RasterRegionCombineMode.set);

               // Draw something on the image
               var command = new Leadtools.ImageProcessing.Color.InvertCommand();
               command.run(image);

               // Save the image
               return Tools.AppLocalFolder().createFileAsync(destFileName)
            })
            .then(function (saveFile) {
               var saveStream = LeadStreamFactory.create(saveFile);
               return codecs.saveAsync(image, saveStream, RasterImageFormat.bmp, 24)
            })
            .then(function () {

               image.close();
               codecs.close();
            });
      }
   }
}

[TestMethod]
public async Task AddRectangleToRegionExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\Image1.cmp";
   string destFileName = @"Image1_AddRectangleToRegion.bmp";

   // Load the image
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Add a 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 = LeadRectHelper.Create(image.ImageWidth / 4, image.ImageHeight / 4, image.ImageWidth / 3, image.ImageHeight / 3);
   image.AddRectangleToRegion(xform, rc, RasterRegionCombineMode.Set);

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

   // Save the image
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   ILeadStream saveStream = LeadStreamFactory.Create(saveFile);
   await codecs.SaveAsync(image, saveStream, RasterImageFormat.Bmp, 24);

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

public void AddRectangleToRegionExample(RasterImage image, Stream destStream)
{
   // Add a 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);
   image.AddRectangleToRegion(xform, rc, RasterRegionCombineMode.Set);

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

   // Save the image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, destStream, RasterImageFormat.Png, 0);

   image.Dispose();
}

Public Sub AddRectangleToRegionExample(ByVal image As RasterImage, ByVal destStream As Stream)
   ' Add a 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)
   image.AddRectangleToRegion(xform, rc, RasterRegionCombineMode.Set)

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

   ' Save the image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, destStream, RasterImageFormat.Png, 0)

   image.Dispose()
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterImage Class
RasterImage Members