AddRectangleToRegion Method

Summary

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

Syntax

Objective-C

C++

Java

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

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

- (BOOL)addRectangleToRegion:(nullable LTRasterRegionXForm *)xform  
                        rect:(LeadRect)rect  
                 combineMode:(LTRasterRegionCombineMode)combineMode  
                       error:(NSError **)error

public void addRectangleToRegion( 
  RasterRegionXForm xform,  
  LeadRect rc,  
  RasterRegionCombineMode 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 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

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.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Dicom; 
using Leadtools.Drawing; 
using Leadtools.Controls; 
using LeadtoolsExamples.Common; 
using Leadtools.Svg; 
 
public void AddRectangleToRegionExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(ImagesPath.Path, "Image1.cmp"); 
   string destFileName = Path.Combine(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; 
 
   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(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Controls 
Imports Leadtools.Dicom 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
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

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Dicom; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Examples; 
using Leadtools.Windows.Media; 
 
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(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Dicom 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
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

Reference

RasterImage Class

RasterImage Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies