burnToRectWithDpi Method (AnnRenderingEngine)

Summary

Burns the annotation objects in Container to the destination context and destination rectangle at the specified resolution.

Syntax

JavaScript Syntax

AnnRenderingEngine.prototype.burnToRectWithDpi = function(destinationRect, sourceDpiX, sourceDpiY, targetDpiX, targetDpiY)

TypeScript Syntax

burnToRectWithDpi(destinationRect: LeadRectD, sourceDpiX: number, sourceDpiY: number, targetDpiX: number, targetDpiY: number): void;

Parameters

destinationRect

The destination rectangle in container coordinates.

sourceDpiX

Horizontal source (screen) DPI.

sourceDpiY

Vertical source (screen) DPI.

targetDpiX

Horizontal target (image) DPI.

targetDpiY

Vertical target (image) DPI.

Remarks

All visible objects in this container will be drawn into the current context.

This method uses the resolution (DPI) values specified and not the values stored in the container. Use this method when burning the container objects into any context.

To burn a container into the context of the image being automated, use Burn.

Example

This example will create a container, adds a couple of objects and then burn it into the viewer

JavaScript Example

example: function SiteLibrary_DefaultPage$example(viewer) { 
   // viewer is ImageViewer this._automation is working on 
 
   // Get the container 
   var container = this._automation.get_container(); 
 
   var inch = 720.0; 
 
   // Add a red line object, from 1in 1in to 2in 2in 
   var lineObj = new lt.Annotations.Core.AnnPolylineObject(); 
   lineObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   lineObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   lineObj.set_stroke(lt.Annotations.Core.AnnStroke.create(lt.Annotations.Core.AnnSolidColorBrush.create("red"), lt.LeadLengthD.create(1))); 
   container.get_children().add(lineObj); 
 
   // Add a blue on yellow rectangle from 3in 3in to 4in 4in 
   var rectObj = new lt.Annotations.Core.AnnRectangleObject(); 
   rectObj.set_rect(lt.LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch)); 
   rectObj.set_stroke(lt.Annotations.Core.AnnStroke.create(lt.Annotations.Core.AnnSolidColorBrush.create("blue"), lt.LeadLengthD.create(1))); 
   rectObj.set_fill(lt.Annotations.Core.AnnSolidColorBrush.create("yellow")); 
   container.get_children().add(rectObj); 
 
   // To burn the annotations, we need a canvas context and a new rendering engine 
 
   // Get the background canvas of the viewer 
   var canvas = viewer.get_backCanvas(); 
   var context = canvas.getContext("2d"); 
 
   // Create a new rendering engine for this container and context 
   var renderingEngine = new lt.Annotations.Rendering.AnnHtml5RenderingEngine(container, context, false); 
 
   // Set the resolution 
   var dpiX = viewer.get_screenDpiX(); 
   var dpiY = viewer.get_screenDpiY(); 
   var xRes = viewer.get_imageDpiX(); 
   var yRes = viewer.get_imageDpiY(); 
 
   // Burn it 
   renderingEngine.burnToRectWithDpi(lt.LeadRectD.get_empty(), dpiX, dpiY, xRes, yRes); 
 
   // Delete the objects we added 
   this._automation.selectObjects(container.get_children()); 
   this._automation.deleteSelectedObjects(); 
 
   // Invalidate to see the burned objects 
   viewer.invalidate(); 
},