AnnContainerMapper Class

Summary

Provides methods for converting values between display, annotations and image coordinates.

Syntax

Objective-C

C++/CLI

Java

Python

public class AnnContainerMapper

@interface LTAnnContainerMapper : NSObject<NSCopying>

public class AnnContainerMapper

public: 
   ref class AnnContainerMapper

class AnnContainerMapper:

Remarks

AnnContainerMapper is used for converting values between display, annotations and image coordinates.

In LEADTOOLS Annotations, all the values are stored in annotations units (1/720 of an inch). For example, when you create a new container and you must set its size; you may write code like this:

C# Snippet

double inch = 720.0; 
// Create a new annotation container 
Leadtools.Annotations.Engine container = new AnnContainer(); 
// Set its size to 8.5 by 11 inches. Size must be in annotation units (1/720 of an inch) 
container.Size = LeadSizeD.Create(8.5 * inch, 11 * inch);

[JavaScript]

var inch = 720.0; 
// Create a new annotation container 
var container = new Leadtools.Annotations.Engine.AnnContainer(); 
// Set its size to 8.5 by 11 inches. Size must be in annotation units (1/720 of an inch) 
container.set_size(Leadtools.LeadSizeD.create(8.5 * inch, 11 * inch));

Similarly, when you create an annotation object and set its location and size, these values must be in annotation coordinates as well:

C# Snippet

// Create a line object from 1, 1 to 2, 2 inches: 
AnnPolylineObject lineObj = new AnnPolylineObject(); 
lineObj.Points.Add(LeadPointD.Create(1 * inch, 1 * inch)); 
lineObj.Points.Add(LeadPointD.Create(2 * inch, 2 * inch));

[JavaScript]

// Create a line object from 1, 1 to 2, 2 inches: 
var lineObj = new Leadtools.Annotations.Engine.AnnPolylineObject(); 
lineObj.get_points().add(Leadtools.LeadPointD.create(1 * inch, 1 * inch)); 
lineObj.get_points().add(Leadtools.LeadPointD.create(2 * inch, 2 * inch));

In automation mode, the user typically draws an annotation object with the mouse or touches the screen using physical screen coordinates. These coordinates must then be transformed to annotation units (1/720 of an inch). To perform this, the mapper needs to know the values of the screen DPI (Dots per Inch). The user must set these values in TargetDpiX and TargetDpiY.

Similarly, when an object is rendered to a target context, the container mapper needs to know the values for the context (or image, during a burn operation) DPI. You must set these values in SourceDpiX and SourceDpiY.

When converting between font size and fixed length and size values between annotation and display coordinates, the mapper will use the values of DeviceDpiX and DeviceDpiY.

To set the DPI values, use MapResolutions. For example, if the current screen resolution is 96 and the container is associated with an image at 300 DPI then you can use the following code:

container.MapResolutions(96, 96, 300, 300);

In cases when the target DPI value is unknown or must be calculated at runtime, such as in the case of medical applications, you can use the Calibrate method to adjust the ratio between the source and target resolution based on a provided known value. The resulting calibration value is stored in CalibrationScale and used by this container throughout.

To render the container to a destination context, a transformation matrix might also be required to perform such operations as scroll and zoom. You can set the value of this matrix in Transform, using the UpdateTransform method.

The mapper can now use all the values above to perform the following:

Convert values from display to container coordinates using PointToContainerCoordinates, PointsToContainerCoordinates, LengthToContainerCoordinates, RectToContainerCoordinates, SizeToContainerCoordinates and FontToContainerCoordinates
Convert values from container to display coordinates using PointFromContainerCoordinates, PointsFromContainerCoordinates, LengthFromContainerCoordinates, RectFromContainerCoordinates, SizeFromContainerCoordinates and FontFromContainerCoordinates

Example

Java

using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Codecs; 
using Leadtools.Annotations.WinForms; 
 
public void AnnContainer_Mapper() 
{ 
   double inch = 720.0; 
 
   // Create a new annotation container, 8.5 by 11 inches 
   AnnContainer container = new AnnContainer(); 
   // Size must be in annotation units (1/720 of an inch) 
   container.Size = LeadSizeD.Create(8.5 * inch, 11 * inch); 
 
   // Set its mapper, assuming the screen DPI is 96 and the image DPI is 300 
   container.Mapper = new AnnContainerMapper(96, 96, 300, 300); 
 
   // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
   AnnRectangleObject rectObj = new AnnRectangleObject(); 
   rectObj.Rect = LeadRectD.Create(3 * inch, 3 * inch, 1 * inch, 1 * inch); 
   rectObj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("Blue"), LeadLengthD.Create(1)); 
   rectObj.Fill = AnnSolidColorBrush.Create("Yellow"); 
   container.Children.Add(rectObj); 
 
   // Get the rectangle in annotations units 
   LeadRectD rc = rectObj.Rect; 
   Debug.WriteLine("Annotations units: " + rc.X + "," + rc.Y + "," + rc.Width + "," + rc.Height); 
 
   // Convert it to image coordinates 
   rc = container.Mapper.RectFromContainerCoordinates(rc, AnnFixedStateOperations.None); 
   Debug.WriteLine("Image units (pixels): " + rc.X + "," + rc.Y + "," + rc.Width + "," + rc.Height); 
 
   // If this container is used with an image, you can use the pixels values above to find the exact value on the image 
 
   // Convert it to back to annotations units 
   rc = container.Mapper.RectToContainerCoordinates(rc); 
   Debug.WriteLine("Original units: " + rc.X + "," + rc.Y + "," + rc.Width + "," + rc.Height); 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.annotations.engine.*; 
 
 
public void annContainerMapperExample() { 
   double inch = 720.0; 
 
   // create a new annotation container, 8.5 by 11 inches 
   AnnContainer container = new AnnContainer(); 
   // Size must be in annotation units (1/720 of an inch) 
   container.setSize(LeadSizeD.create(8.5 * inch, 11 * inch)); 
 
   // Set its mapper, assuming the screen DPI is 96 and the image DPI is 300 
   container.setMapper(new AnnContainerMapper(96, 96, 300, 300)); 
 
   // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
   AnnRectangleObject rectObj = new AnnRectangleObject(); 
   rectObj.setRect(LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch)); 
   rectObj.setStroke(AnnStroke.create(AnnSolidColorBrush.create("Blue"), LeadLengthD.create(1))); 
   rectObj.setFill(AnnSolidColorBrush.create("Yellow")); 
   container.getChildren().add(rectObj); 
 
   // Get the rectangle in annotations units 
   LeadRectD rc = rectObj.getRect(); 
   System.out 
         .println("Annotations units: " + rc.getX() + "," + rc.getY() + "," + rc.getWidth() + "," + rc.getHeight()); 
 
   // Convert it to image coordinates 
   rc = container.getMapper().rectToContainerCoordinates(rc); 
   System.out.println( 
         "Image units (pixels): " + rc.getX() + "," + rc.getY() + "," + rc.getWidth() + "," + rc.getHeight()); 
 
   // If this container is used with an image, you can use the pixels values above 
   // to find the exact value on the image 
 
   // Convert it to back to annotations units 
   rc = container.getMapper().rectToContainerCoordinates(rc); 
   System.out.println("Original units: " + rc.getX() + "," + rc.getY() + "," + rc.getWidth() + "," + rc.getHeight()); 
}

Requirements

Target Platforms

Reference

AnnContainerMapper Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies