TunnelCommand Constructor(LeadPoint,Int32,Int32,Int32,Int32,Int32,Int32,Int32,Int32,Int32,RasterColor,RasterColor,TunnelCommandFlags)

Initializes a new TunnelCommand class object with explicit parameters.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public TunnelCommand( 
   LeadPoint centerPoint,
   int zValue,
   int distance,
   int radius,
   int repeat,
   int rotationOffset,
   int stretch,
   int startBright,
   int endBright,
   int brightLength,
   RasterColor brightColor,
   RasterColor fillColor,
   TunnelCommandFlags flags
)

'Declaration
 
Public Function New( _
   ByVal centerPoint As LeadPoint, _
   ByVal zValue As Integer, _
   ByVal distance As Integer, _
   ByVal radius As Integer, _
   ByVal repeat As Integer, _
   ByVal rotationOffset As Integer, _
   ByVal stretch As Integer, _
   ByVal startBright As Integer, _
   ByVal endBright As Integer, _
   ByVal brightLength As Integer, _
   ByVal brightColor As RasterColor, _
   ByVal fillColor As RasterColor, _
   ByVal flags As TunnelCommandFlags _
)

'Usage
 
Dim centerPoint As LeadPoint
Dim zValue As Integer
Dim distance As Integer
Dim radius As Integer
Dim repeat As Integer
Dim rotationOffset As Integer
Dim stretch As Integer
Dim startBright As Integer
Dim endBright As Integer
Dim brightLength As Integer
Dim brightColor As RasterColor
Dim fillColor As RasterColor
Dim flags As TunnelCommandFlags
 
Dim instance As New TunnelCommand(centerPoint, zValue, distance, radius, repeat, rotationOffset, stretch, startBright, endBright, brightLength, brightColor, fillColor, flags)

public TunnelCommand( 
   LeadPoint centerPoint,
   int zValue,
   int distance,
   int radius,
   int repeat,
   int rotationOffset,
   int stretch,
   int startBright,
   int endBright,
   int brightLength,
   RasterColor brightColor,
   RasterColor fillColor,
   TunnelCommandFlags flags
)

function TunnelCommand( 
   centerPoint ,
   zValue ,
   distance ,
   radius ,
   repeat ,
   rotationOffset ,
   stretch ,
   startBright ,
   endBright ,
   brightLength ,
   brightColor ,
   fillColor ,
   flags 
)

public:
TunnelCommand( 
   LeadPoint centerPoint,
   int zValue,
   int distance,
   int radius,
   int repeat,
   int rotationOffset,
   int stretch,
   int startBright,
   int endBright,
   int brightLength,
   RasterColor brightColor,
   RasterColor fillColor,
   TunnelCommandFlags flags
)

Parameters

centerPoint: Contains the point at which the camera or viewer is looking. It may be outside the image borders.
zValue: Viewing screen offset on the Z-axis, in pixels. This parameter only accepts positive values.
distance: Camera distance from the viewing screen, in pixels.
radius: Tunnel radius. This parameter only accepts positive values.
repeat: Number of times the image repeats along the Z-axis. If repeat equals -1 the image will be infinitely repeated. Its range starts from -1.
rotationOffset: Rotates tunnel around the Z-axis in pixel steps. If TunnelCommandFlags.WidthAxis option is selected then the image width is along the Z-axis and RotationOffset set to the image height is equivalent to a complete cycle. If TunnelCommandFlags.HeightAxis option is set, then the image height is along the Z-axis and RotationOffset set to the image width is equivalent to a complete cycle.
stretch: Value that indicates whether to expand or compress the image, and by how much. If Stretch < 100 image will be expanded. If Stretch > 100 the image will be compressed. Use 100 to maintain the image's dimensions. The value of this parameter is internally divided by 100. This parameter only accepts positive values.
startBright: Value that indicates the brightness of an external light source at the beginning of the tunnel. Possible values range from 0 to 100. A value of 0 indicates no external light is displayed at the beginning of the tunnel. A value of 100 indicates an external light source with full brightness is displayed.
endBright: Value that indicates the brightness of an external light source at the end of the tunnel. Possible values range from 0 to 100. A value of 0 indicates no external light displayed at the end of the tunnel. A value of 100 indicates an external light source with full brightness is displayed on the image.
brightLength: Value that indicates how much the brightness changes as you move along the Z axis. This parameter is internally multiplied by 50. This property only accepts positive values.
brightColor: Specifies the color of an external light source that shines in the tunnel.
fillColor: Specifies the background color.
flags: Flag that indicates the background color and which image dimension extends along the Z-axis.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub TunnelConstructorExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' Prepare the command
   Dim command As TunnelCommand = New TunnelCommand(New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2), 0, leadImage.Height, leadImage.Width \ 2, -1, 0, 25, 0, 100, 20000, New RasterColor(255, 255, 255), New RasterColor(0, 0, 0), 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

public void TunnelConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));

      // Prepare the command
      TunnelCommand command = new TunnelCommand(new LeadPoint(image.Width / 2, image.Height / 2), 0, image.Height, image.Width / 2, -1, 0, 25, 0, 100, 20000, new RasterColor(255, 255, 255), new RasterColor(0, 0, 0), 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";
}

[TestMethod]
public async Task TunnelConstructorExample()
{
   // 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(LeadPointHelper.Create(image.Width / 2, image.Height / 2), 0, image.Height, image.Width / 2, -1, 0, 25, 0, 100, 20000, RasterColorHelper.Create(255, 255, 255), RasterColorHelper.Create(0, 0, 0), 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);
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

TunnelCommand Class
TunnelCommand Members
Overload List