OffsetCommand Class

C#
Visual Basic
WinRT C#
Java
Objective-C
WinRT JavaScript
C++

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

'Declaration

Public Class OffsetCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage

Dim instance As OffsetCommand

public sealed class OffsetCommand : Leadtools.ImageProcessing.IRasterCommand

@interface LTOffsetCommand : LTRasterCommand

public class OffsetCommand extends RasterCommand

function Leadtools.ImageProcessing.Effects.OffsetCommand()

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

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.

In Silverlight versions of LEADTOOLS, this image processing command will fail if the image data for the RasterImage object is stored internally using a Silverlight WriteableBitmap object. For more information, refer to Image Processing Command Limitations in Silverlight.

Run the OffsetCommand on an image.

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

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.Effects

   
Public Sub OffsetCommandExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\\NaturalFruits.jpg"))

   ' Prepare the command
   Dim command As OffsetCommand = New OffsetCommand
   command.HorizontalShift = leadImage.Width \ 2
   command.VerticalShift = leadImage.Height \ 2
   command.BackColor = New RasterColor(128, 128, 128)
   command.Type = OffsetCommandType.Color
   'Apply offset on the image.
   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

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Effects;

      
public void OffsetCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, @"ImageProcessingDemo\NaturalFruits.jpg"));

   // Prepare the command
   OffsetCommand command = new OffsetCommand();
   command.HorizontalShift = image.Width / 2;
   command.VerticalShift = image.Height / 2;
   command.BackColor = new RasterColor(128, 128, 128);
   command.Type = OffsetCommandType.Color;
   //Apply offset on the image.
   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";
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Effects;
using Leadtools.ImageProcessing;

      
public async Task OffsetCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   // Load the image
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   OffsetCommand command = new OffsetCommand();
   command.HorizontalShift = image.Width / 2;
   command.VerticalShift = image.Height / 2;
   command.BackColor = RasterColorHelper.Create(128, 128, 128);
   command.Type = OffsetCommandType.Color;
   //Apply offset on the image.
   command.Run(image);
   //Save as BMP
   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);

}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.Effects;
using Leadtools.Examples;

public void OffsetCommandExample(RasterImage image, Stream outStream)
{
   // Prepare the command
   OffsetCommand command = new OffsetCommand();
   command.HorizontalShift = image.Width / 2;
   command.VerticalShift = image.Height / 2;
   command.BackColor = new RasterColor(128, 128, 128);
   command.Type = OffsetCommandType.Color;
   //Apply offset on the image.
   command.Run(image);
   // Save result image
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24);
   image.Dispose();
}

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.Effects

Public Sub OffsetCommandExample(ByVal image As RasterImage, ByVal outStream As Stream)
   ' Prepare the command
   Dim command As OffsetCommand = New OffsetCommand()
   command.HorizontalShift = image.Width / 2
   command.VerticalShift = image.Height / 2
   command.BackColor = New RasterColor(128, 128, 128)
   command.Type = OffsetCommandType.Color
   'Apply offset on the image.
   command.Run(image)
   ' Save result image
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24)
   image.Dispose()
End Sub

Target Platforms

Reference