PlaneCommand Class

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

public class PlaneCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration
 
Public Class PlaneCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage
 
Dim instance As PlaneCommand

public sealed class PlaneCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.SpecialEffects.PlaneCommand()

public ref class PlaneCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

This command shows the effect of placing images on planes 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.
By changing CenterPoint and the viewing screen Z-offset, you can 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 LeadPoint(320, 256)
2. ZValue = 0
3. Distance = 256
4. PlaneOffset = 256
5. Repeat = -1
6. PyramidAngle = 0
7. Stretch = 100
8. StartBright = 0
9. EndBright = 0
10. BrightLength = 50
11. BrightColor = new Leadtools.RasterColor(255, 255, 255)
12. FillColor = new Leadtools.RasterColor(0, 0, 0)
13. Flags = PlaneCommandFlags.Down | PlaneCommandFlags.Color
14. This command does not support 32-bit grayscale images.
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.

For more information, refer to Introduction to Image Processing With LEADTOOLS.
For more information, refer to Correcting Colors.

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

Public Sub PlaneCommandExample()
   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
   command.CenterPoint = New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2)
   command.ZValue = 0
   command.Distance = leadImage.Height
   command.PlaneOffset = leadImage.Width \ 2
   command.Repeat = -1
   command.PyramidAngle = 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 = 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 PlaneCommandExample()
   {
      // 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();
      command.CenterPoint = new LeadPoint(image.Width / 2, image.Height / 2);
      command.ZValue = 0;
      command.Distance = image.Height;
      command.PlaneOffset = image.Width /2;
      command.Repeat = -1;
      command.PyramidAngle = 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 = 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 PlaneCommandExample()
{
   // 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();
   command.CenterPoint = LeadPointHelper.Create(image.Width / 2, image.Height / 2);
   command.ZValue = 0;
   command.Distance = image.Height;
   command.PlaneOffset = image.Width /2;
   command.Repeat = -1;
   command.PyramidAngle = 0;
   command.Stretch = 25;
   command.StartBright = 0;
   command.EndBright = 100;
   command.BrightLength = 20000;
   command.BrightColor = RasterColorHelper.Create(255, 255, 255);
   command.FillColor = RasterColorHelper.Create(0, 0, 0);
   command.Flags = 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);
}

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