Public Function New( _
   ByVal centerPoint As Point, _
   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 _
)

Visual Basic (Usage)

Copy Code

Dim centerPoint As Point 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 TunnelCommand(centerPoint, zValue, distance, radius, repeat, rotationOffset, stretch, startBright, endBright, brightLength, brightColor, fillColor, flags)

public TunnelCommand( 
   Point 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
)

public:
TunnelCommand( 
   Point 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.

Run the TunnelCommand on an image.

Visual Basic

Copy Code

Public Sub TunnelConstructorExample()    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(New Point(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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)    RasterCodecs.Shutdown() End Sub

C#

Copy Code

public void TunnelConstructorExample()  {     // 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(new Point(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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24);       RasterCodecs.Shutdown();  }

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

Reference