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

Summary

Initializes a new TunnelCommand class object with explicit parameters.

Syntax

C++/CLI

Python

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 
)

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 
)

__init__(self,centerPoint,zValue,distance,radius,repeat,rotationOffset,stretch,startBright,endBright,brightLength,brightColor,fillColor,flags) # Overloaded constructor

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

Run the TunnelCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
 
public void TunnelConstructorExample() 
{ 
   // 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(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:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

TunnelCommand Class

TunnelCommand Members

Overload List

Download our FREE evaluation

Help Version 22.0.2023.3.31

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies