←Select platform

TunnelCommand Class

Summary

Places the image inside a tunnel along the Z-axis. This command is available in the Imaging Pro and above toolkits.

Syntax

WinRT C#

C++

public class TunnelCommand : Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand, Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

Public Class TunnelCommand  
   Inherits Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand 
   Implements Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

public sealed class TunnelCommand : Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.SpecialEffects.TunnelCommand()

public ref class TunnelCommand : public Leadtools.Imageprocessing.Leadtools.ImageProcessing.RasterCommand, Leadtools.Imageprocessing.Leadtools.ImageProcessing.IRasterCommand

Remarks

This command shows the effect of placing images on tunnels along the Z-axis and bending them toward a specific point. These images may be placed above, below, to the left or to the right of the Z-axis. An external light source of the specified color and brightness may be shined on the images. The brightness may vary along the z-axis according to the BrightLength value.
Changing the camera center point, the rotation angle and the viewing screen Z-offset will simulate moving along the axis.
If the image has a region, the effect will be applied on the region dimensions only.
For an example, see the following figure:

The following figure shows the same image, after the effect has been applied:

To obtain this effect, the following settings were used with the command:
CenterPoint = new Leadtools.LeadPoint(320, 256)
ZValue = 0
Distance = 200
Radius = 200
Repeat = -1
RotationOffset = 75
Stretch = 25
StartBright = 0
EndBright = 100
BrightLength = 45
BrightColor = new Leadtools.RasterColor(255, 255, 255)
FillColor = new Leadtools.RasterColor(255, 255, 255)
Flags = TunnelCommandFlags.WidthAxis | TunnelCommandFlags.Color
This command supports 12-bit and 16-bit grayscale and 48-bit and 64-bit color images. Support for 12-bit and 16-bit grayscale and 48-bit and 64-bit color images is available only in the Document/Medical toolkits.
This command does not support signed data images.
This command does not support 32-bit grayscale images.

For more information, refer to Introduction to Image Processing With LEADTOOLS. For more information, refer to Correcting Colors.

Example

Run the TunnelCommand on an image.

WinRT C#

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
 
<TestMethod()> _ 
Public Sub TunnelCommandExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\\Beauty16.jpg")) 
 
   ' Prepare the command 
   Dim command As TunnelCommand = New TunnelCommand 
   command.CenterPoint = New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2) 
   command.ZValue = 0 
   command.Distance = leadImage.Height 
   command.Radius = leadImage.Width \ 2 
   command.Repeat = -1 
   command.RotationOffset = 0 
   command.Stretch = 25 
   command.StartBright = 0 
   command.EndBright = 100 
   command.BrightLength = 20000 
   command.BrightColor = New RasterColor(255, 255, 255) 
   command.FillColor = New RasterColor(0, 0, 0) 
   command.Flags = TunnelCommandFlags.WidthAxis Or TunnelCommandFlags.Color 
   command.Run(leadImage) 
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24) 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void TunnelCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, @"ImageProcessingDemo\Beauty16.jpg")); 
 
   // Prepare the command 
   TunnelCommand command = new  TunnelCommand(); 
   command.CenterPoint = new LeadPoint(image.Width / 2, image.Height / 2); 
   command.ZValue = 0; 
   command.Distance = image.Height; 
   command.Radius = image.Width / 2; 
   command.Repeat = -1; 
   command.RotationOffset = 0; 
   command.Stretch = 25; 
   command.StartBright = 0; 
   command.EndBright = 100; 
   command.BrightLength = 20000; 
   command.BrightColor = new RasterColor(255, 255, 255); 
   command.FillColor = new RasterColor(0, 0, 0); 
   command.Flags =  TunnelCommandFlags.WidthAxis |  TunnelCommandFlags.Color; 
   command.Run(image); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24); 
 
} 
 
static class LEAD_VARS 
{ 
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public async Task TunnelCommandExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   string srcFileName = @"Assets\Image1.cmp"; 
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName); 
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile)); 
 
   // Prepare the command 
   TunnelCommand command = new  TunnelCommand(); 
   command.CenterPoint = LeadPointHelper.Create(image.Width / 2, image.Height / 2); 
   command.ZValue = 0; 
   command.Distance = image.Height; 
   command.Radius = image.Width / 2; 
   command.Repeat = -1; 
   command.RotationOffset = 0; 
   command.Stretch = 25; 
   command.StartBright = 0; 
   command.EndBright = 100; 
   command.BrightLength = 20000; 
   command.BrightColor = RasterColorHelper.Create(255, 255, 255); 
   command.FillColor = RasterColorHelper.Create(0, 0, 0); 
   command.Flags =  TunnelCommandFlags.WidthAxis |  TunnelCommandFlags.Color; 
   command.Run(image); 
 
   string destFileName = @"result.bmp"; 
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName); 
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24); 
}