Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
AddRectangleToRegion Method
See Also  Example
Leadtools Namespace > RasterImage Class : AddRectangleToRegion 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 Rectangle that specifies the region.
combineMode
The action to take regarding the existing image region, if one is defined.
Creates or updates the image region by adding a rectangular region.

Syntax

Visual Basic (Declaration) 
Public Sub AddRectangleToRegion( _
   ByVal xform As RasterRegionXForm, _
   ByVal rc As Rectangle, _
   ByVal combineMode As RasterRegionCombineMode _
)
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim xform As RasterRegionXForm
Dim rc As Rectangle
Dim combineMode As RasterRegionCombineMode
 
instance.AddRectangleToRegion(xform, rc, combineMode)
C# 
public void AddRectangleToRegion( 
   RasterRegionXForm xform,
   Rectangle rc,
   RasterRegionCombineMode combineMode
)
C++/CLI 
public:
void AddRectangleToRegion( 
   RasterRegionXForm^ xform,
   Rectangle 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 Rectangle that specifies the region.
combineMode
The action to take regarding the existing image region, if one is defined.

Example

This example loads an image, adds a rectangle region to it, and runs the InvertCommand to show the affected area before saving the image back to disk.

Visual BasicCopy Code
Public Sub AddRectangleToRegionExample()
   RasterCodecs.Startup()
   Dim codecs As RasterCodecs = New RasterCodecs()

   Dim srcFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"
   Dim destFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "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 Rectangle = New Rectangle(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()
   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void AddRectangleToRegionExample() 
{ 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = LeadtoolsExamples.Common.ImagesPath.Path + "Image1.cmp"; 
   string destFileName = LeadtoolsExamples.Common.ImagesPath.Path + "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; 
 
   Rectangle rc = new Rectangle(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(); 
   RasterCodecs.Shutdown(); 
}

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.

For more information, refer to The RasterPaintEngine Property and 16bpp Grayscale Images.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also