GetRegion Method

Summary

Gets the RasterRegion object that describes this RasterImage current region.

Syntax

Objective-C

C++

Java

public RasterRegion GetRegion( 
   RasterRegionXForm xform 
)

Public Function GetRegion( _ 
   ByVal xform As RasterRegionXForm _ 
) As RasterRegion

- (nullable LTRasterRegion *)getRegion:(nullable LTRasterRegionXForm *)xform error:(NSError **)error

public RasterRegion getRegion(RasterRegionXForm xform)

public: 
RasterRegion^ GetRegion(  
   RasterRegionXForm^ xform 
)

Parameters

xform
RasterRegionXForm object that LEADTOOLS uses to translate between display coordinates and image coordinates. If you specify null for this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to the image view perspective.

Return Value

An RasterRegion object that describes this RasterImage current region.

Remarks

To set or updated the RasterRegion object that describes the current image region, use SetRegion.

If the image does not have a region, this method will return an empty RasterRegion object.

The RasterRegion class provides a platform independent representation of a region of interest in an image that can be used in any platform supported by LEADTOOLS such as GDI, GDI+, and WPF. The RasterRegion class contains extensive methods and properties to manipulate the region data and save/load it to a byte array.

To convert a LEADTOOLS RasterRegion object to/from a device dependent region, you can use the following helper classes:

Leadtools.Drawing.RasterRegionConverter to convert to/from a System.Drawing (GDI+) System.Drawing.Region or Windows HRGN objects.
Leadtools.Windows.Media.RasterRegionConverter to convert to/from a WPF System.Windows.Media.Geometry object.

The RasterRegion class implements the IDisposable interface, so you must call Dispose on any region objects you create after using it.

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

For an example, refer to RasterRegion.

Requirements

Target Platforms