BurnToRect Method

Summary

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

Syntax

Objective-C

C++/CLI

Java

Python

public void BurnToRect( 
   LeadRectD destinationRect 
)

- (void)burnToRect:(LeadRectD)destinationRect NS_SWIFT_NAME(burn(to:));

public void burnToRect(LeadRectD destinationRect)

public:  
   void BurnToRect( 
      LeadRectD^ destinationRect 
   )

def BurnToRect(self,destinationRect):

Parameters

destinationRect
The destination rectangle in container coordinates.

Remarks

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

This method uses the resolution (DPI) values stored in the container. Use this method when burning the container objects into the context of the image currently being used in the automation.

To burn a container into a context while specifying new resolution (DPI) values, use BurnToRectWithDpi.

Example

This example will create a container, adds a couple of objects and then burn it to a canvas

using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Annotations.Rendering; 
using Leadtools.Codecs; 
using Leadtools.Annotations; 
using Leadtools.WinForms; 
 
public void AnnRenderingEngine_BurnToRect(/*RasterImage image*/) 
{ 
   // Get the container 
   AnnContainer container = _automation.Container; 
   RasterImage image = _viewer.Image; 
 
   double inch = 720.0; 
 
   // Add a red line object, from 1in 1in to 2in 2in 
   AnnPolylineObject lineObj = new AnnPolylineObject(); 
   lineObj.Points.Add(LeadPointD.Create(1 * inch, 1 * inch)); 
   lineObj.Points.Add(LeadPointD.Create(2 * inch, 2 * inch)); 
   lineObj.Stroke = AnnStroke.Create(AnnSolidColorBrush.Create("Red"), LeadLengthD.Create(1)); 
   container.Children.Add(lineObj); 
 
   // 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 destination rectangle in container coordinates 
   // The canvas DPI is 96, and the units are 1/720 of an inch 
   // So, sizeInUnits = (sizeInPixels / dpi) = size in inches * 720 = size in container units 
   // Or, we can use the annotations mapper, like this 
   AnnContainerMapper mapper = AnnContainerMapper.CreateDefault(); 
   LeadRectD rc = LeadRectD.Create(0, 0, 200, 200); 
   rc = mapper.RectToContainerCoordinates(rc); 
 
   // Burn the annotations on this image 
 
   IAnnAutomationControl annAutomationControl = _automation.AutomationControl; 
 
   RasterColor[] colors = image.GetPalette(); 
   IntPtr hDC = Leadtools.Drawing.RasterImagePainter.CreateLeadDC(image); 
   if (hDC != null) 
   { 
      using (Graphics g = Graphics.FromHdc(hDC)) 
      { 
         // Create a new rendering engine for this container and context 
         AnnWinFormsRenderingEngine renderingEngine = new AnnWinFormsRenderingEngine(container, g); 
 
         // Burn it 
         renderingEngine.BurnToRect(rc); 
      } 
 
      Leadtools.Drawing.RasterImagePainter.DeleteLeadDC(hDC); 
   } 
 
   // Invalidate 
   _automation.Invalidate(LeadRectD.Empty); 
}

Requirements

Target Platforms

Reference

AnnRenderingEngine Class

AnnRenderingEngine Members

Download our FREE evaluation

Help Version 22.0.2023.7.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies