PlaneCommand Constructor(LeadPoint,Int32,Int32,Int32,Int32,Int32,Int32,Int32,Int32,Int32,RasterColor,RasterColor,PlaneCommandFlags)

Initializes a new PlaneCommand class object with explicit parameters.

Syntax

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

public PlaneCommand( 
   LeadPoint centerPoint,
   int zValue,
   int distance,
   int planeOffset,
   int repeat,
   int pyramidAngle,
   int stretch,
   int startBright,
   int endBright,
   int brightLength,
   RasterColor brightColor,
   RasterColor fillColor,
   PlaneCommandFlags flags
)

'Declaration
 
Public Function New( _
   ByVal centerPoint As LeadPoint, _
   ByVal zValue As Integer, _
   ByVal distance As Integer, _
   ByVal planeOffset As Integer, _
   ByVal repeat As Integer, _
   ByVal pyramidAngle 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 PlaneCommandFlags _
)

'Usage
 
Dim centerPoint As LeadPoint
Dim zValue As Integer
Dim distance As Integer
Dim planeOffset As Integer
Dim repeat As Integer
Dim pyramidAngle 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 PlaneCommandFlags
 
Dim instance As New PlaneCommand(centerPoint, zValue, distance, planeOffset, repeat, pyramidAngle, stretch, startBright, endBright, brightLength, brightColor, fillColor, flags)

public PlaneCommand( 
   LeadPoint centerPoint,
   int zValue,
   int distance,
   int planeOffset,
   int repeat,
   int pyramidAngle,
   int stretch,
   int startBright,
   int endBright,
   int brightLength,
   RasterColor brightColor,
   RasterColor fillColor,
   PlaneCommandFlags flags
)

function PlaneCommand( 
   centerPoint ,
   zValue ,
   distance ,
   planeOffset ,
   repeat ,
   pyramidAngle ,
   stretch ,
   startBright ,
   endBright ,
   brightLength ,
   brightColor ,
   fillColor ,
   flags 
)

public:
PlaneCommand( 
   LeadPoint centerPoint,
   int zValue,
   int distance,
   int planeOffset,
   int repeat,
   int pyramidAngle,
   int stretch,
   int startBright,
   int endBright,
   int brightLength,
   RasterColor brightColor,
   RasterColor fillColor,
   PlaneCommandFlags flags
)

Parameters

centerPoint: Contains the point at which the camera or viewer is looking. This is also the point toward which the images will be bent. It may be outside the image borders.
zValue: Viewing screen offset on the Z-axis, in pixels.
distance: Camera distance from the viewing screen, in pixels.
planeOffset: Distance between the parallel planes. This property 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.
pyramidAngle: The view angle, off the Z-axis. This value is given in hundredths of a degree (+/-). This can be a number from 0 to 36,000.
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 on the first image displayed. Possible values range from 0 to 100. A value of 0 indicates no external light displayed on the image. A value of 100 indicates an external light source with full brightness is displayed on the image.
endBright: Value that indicates the brightness of an external light source on the last image displayed. Possible values range from 0 to 100. A value of 0 indicates no external light displayed on the image. 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 property is internally multiplied by 50.
brightColor: Specifies the color of an external light source that shines on the displayed images.
fillColor: Specifies the background color.
flags: Flags that indicate the background color and the planes to be shown. You can use a bit wise OR (|) to specify one flag from each group.

Example

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

Public Sub PlaneConstructorExample()
   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 PlaneCommand = New PlaneCommand(New LeadPoint(CType((leadImage.Width / 2), Integer), CType((leadImage.Height / 2), Integer)), 0, leadImage.Height, CType((leadImage.Width / 2), Integer), -1, 0, 25, 0, 100, 20000, New RasterColor(255, 255, 255), New RasterColor(0, 0, 0), PlaneCommandFlags.Right Or PlaneCommandFlags.Left Or PlaneCommandFlags.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 PlaneConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      PlaneCommand command = new PlaneCommand(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), PlaneCommandFlags.Right | PlaneCommandFlags.Left | PlaneCommandFlags.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 PlaneConstructorExample()
{
   // 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
   PlaneCommand command = new PlaneCommand(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), PlaneCommandFlags.Right | PlaneCommandFlags.Left | PlaneCommandFlags.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

PlaneCommand Class
PlaneCommand Members
Overload List