Leadtools.ImageProcessing.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
TunnelCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.SpecialEffects Namespace : TunnelCommand Class



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

Syntax

Visual Basic (Declaration)  
Public Class TunnelCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage) Copy Code
Dim instance As TunnelCommand
C#  
public class TunnelCommand : RasterCommand, IRasterCommand 
C++/CLI  
public ref class TunnelCommand : public RasterCommand, IRasterCommand 

Example

Run the TunnelCommand on an image.

Visual Basic Copy Code
Public Sub TunnelCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim command As TunnelCommand = New TunnelCommand
   command.CenterPoint = New Point(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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void TunnelCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   TunnelCommand command = new  TunnelCommand(); 
   command.CenterPoint = new Point(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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

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:
    1. CenterPoint = new Point(320, 256)
    2. ZValue = 0
    3. Distance = 200
    4. Radius = 200
    5. Repeat = -1
    6. RotationOffset = 75
    7. Stretch = 25
    8. StartBright = 0
    9. EndBright = 100
    10. BrightLength = 45
    11. BrightColor = new RasterColor(255, 255, 255)
    12. FillColor = new RasterColor(255, 255, 255)
    13. Flags = TunnelCommandFlags.WidthAxis | TunnelCommandFlags.Color
  • This command supports 12- and 16-bit grayscale and 48- and 64-bit color images. Support for 12- and 16-bit grayscale and 48- 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.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.SpecialEffects.TunnelCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also