LightCommand Class

Adds many spots of directed light sources to the image. This command is available in the Raster Pro and above toolkits.

Object Model

Syntax

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

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

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

'Usage
 
Dim instance As LightCommand

public sealed class LightCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.SpecialEffects.LightCommand()

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

Remarks

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.
This command does not support 32-bit grayscale images.

For more information, refer to Applying Artistic Effects.
For more information, refer to Correcting Colors.

Example

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

Public Sub LightCommandExample()
   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 Data() As LightCommandData
   ReDim Data(0)
   Data(0) = New LightCommandData
   Data(0).Angle = 0
   Data(0).CenterPoint = New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2)
   Data(0).Edge = 0
   Data(0).Brightness = 100
   Data(0).FillColor = New RasterColor(255, 255, 255)
   Data(0).Height = Math.Min(leadImage.Height, leadImage.Width) \ 2
   Data(0).Width = Math.Min(leadImage.Height, leadImage.Width) \ 2
   Data(0).Opacity = 100
   Data(0).Type = LightCommandType.Spot

   Dim command As LightCommand = New LightCommand
   command.Ambient = 100
   command.Bright = 100
   command.Data = Data
   command.AmbientColor = New RasterColor(255, 255, 255)
   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 LightCommandExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      LightCommandData[] Data = new LightCommandData[1];
      Data[0].Angle           = 0;
      Data[0].CenterPoint     = new LeadPoint(image.Width / 2, image.Height / 2);
      Data[0].Edge            = 0;
      Data[0].Brightness      = 100;
      Data[0].FillColor       = new RasterColor(255, 255, 255);
      Data[0].Height          = Math.Min(image.Height, image.Width) / 2;
      Data[0].Width           = Math.Min(image.Height, image.Width) / 2;
      Data[0].Opacity         = 100;
      Data[0].Type            = LightCommandType.Spot;

      LightCommand command = new LightCommand();
      command.Ambient = 100;
      command.Bright  = 100;
      command.Data = Data;
      command.AmbientColor = new RasterColor(255, 255, 255);
      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 LightCommandExample()
{
   // 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
   LightCommandData[] Data = new LightCommandData[1];
   Data[0].Angle           = 0;
   Data[0].CenterPoint     = LeadPointHelper.Create(image.Width / 2, image.Height / 2);
   Data[0].Edge            = 0;
   Data[0].Brightness      = 100;
   Data[0].FillColor       = RasterColorHelper.Create(255, 255, 255);
   Data[0].Height          = Math.Min(image.Height, image.Width) / 2;
   Data[0].Width           = Math.Min(image.Height, image.Width) / 2;
   Data[0].Opacity         = 100;
   Data[0].Type            = LightCommandType.Spot;

   LightCommand command = new LightCommand();
   command.Ambient = 100;
   command.Bright  = 100;
   command.Data = Data;
   command.AmbientColor = RasterColorHelper.Create(255, 255, 255);
   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