CodecsVectorLoadOptions Class

Summary

Contains options for loading a vector file as a raster image (rasterization).

Syntax

C++

Java

public class CodecsVectorLoadOptions

Public Class CodecsVectorLoadOptions

public class CodecsVectorLoadOptions

public ref class CodecsVectorLoadOptions

Remarks

LEADTOOLS provides support for loading a vector image as a raster image. Vector formats such as DXF, DWG and SVG can be converted to a raster image through a process called rasterization.

Rasterization is the process of converting a vector image to a raster image. To determine whether a certain file on disk (or in a .NET stream) contains a vector image file rather than a regular raster image, call the RasterCodecs.GetInformation or RasterCodecs.GetInformationAsync method and check the CodecsVectorImageInfo.IsVectorFile property. Here is a code snippet:

CodecsImageInfo imageInfo = rasterCodecsInstance.GetInformation(fileName, true); 
if(imageInfo.Vector.IsVectorFile) 
{ 
   // A vector image file (DXF, DWG, SVG, etc) 
   Console.WriteLine("Vector file"); 
   // Your code specific to working with a vector image goes here 
}

To rasterize a vector image file, set the properties of the CodecsVectorLoadOptions to the desired values, and then call the RasterCodecs.Load or RasterCodecs.LoadAsync methods.

A vector image file format usually does not have a physical size. The user can specify a viewport (physical size up to which the drawing can be rendered) ViewWidth and ViewHeight. How the drawing is to be rendered inside this viewport depends on the current viewport mode set with ViewMode. Default viewport size is 640x480 pixels.

Example

using Leadtools; 
using Leadtools.Codecs; 
 
public void CodecsVectorLoadOptionsExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "random.dxf"); 
 
   // Set the vector load options 
   codecs.Options.Vector.Load.BackgroundColor = new RasterColor(255, 255, 255); 
   codecs.Options.Vector.Load.BitsPerPixel = 24; 
   codecs.Options.Vector.Load.ForceBackgroundColor = true; 
   codecs.Options.Vector.Load.ViewWidth = 800; 
   codecs.Options.Vector.Load.ViewHeight = 800; 
   codecs.Options.Vector.Load.ViewMode = CodecsVectorViewMode.UseBest; 
 
   // Load the image 
   RasterImage image = codecs.Load(srcFileName); 
 
   // do something with the image here 
 
   // Clean up 
   image.Dispose(); 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
 
Sub CodecsVectorLoadOptionsExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "random.dxf") 
 
   ' Set the vector load options 
   codecs.Options.Vector.Load.BackgroundColor = New RasterColor(255, 255, 255) 
   codecs.Options.Vector.Load.BitsPerPixel = 24 
   codecs.Options.Vector.Load.ForceBackgroundColor = True 
   codecs.Options.Vector.Load.ViewWidth = 800 
   codecs.Options.Vector.Load.ViewHeight = 800 
   codecs.Options.Vector.Load.ViewMode = CodecsVectorViewMode.UseBest 
 
   ' Load the image 
   Dim image As RasterImage = codecs.Load(srcFileName) 
 
   ' do something with the image here 
 
   ' Clean up 
   image.Dispose() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

CodecsVectorLoadOptions Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies