Leadtools.ImageProcessing.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
FreeHandWaveCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.SpecialEffects Namespace : FreeHandWaveCommand Class



Distorts the image by the wave specified in the amplitudes array and the rotation angle. This command is available in the Raster Pro and above toolkits.

Syntax

Visual Basic (Declaration)  
Public Class FreeHandWaveCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage) Copy Code
Dim instance As FreeHandWaveCommand
C#  
public class FreeHandWaveCommand : RasterCommand, IRasterCommand 
C++/CLI  
public ref class FreeHandWaveCommand : public RasterCommand, IRasterCommand 

Example

Run the FreeHandWaveCommand on an image and apply triangular wave on the loaded image.

Visual Basic Copy Code
Public Sub FreeHandWaveCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim UserPoint() As Point
   ReDim UserPoint(3)

   Dim Amplitudes() As Integer
   ReDim Amplitudes(12)

   Dim command As FreeHandWaveCommand = New FreeHandWaveCommand

   ' Fill UserPoint array with points that define a triangular wave
   UserPoint(0).X = 0
   UserPoint(0).Y = 0
   UserPoint(1).X = 3
   UserPoint(1).Y = 10
   UserPoint(2).X = 9
   UserPoint(2).Y = -10
   UserPoint(3).X = 12
   UserPoint(3).Y = 0

   'Draw a triangular wave according to UserPoint points and store the Amplitudes values in the Amplitudes array
   EffectsUtilities.GetCurvePoints(Amplitudes, UserPoint, CurvePointsType.Linear)

   command.Amplitudes = Amplitudes
   command.Scale = 100
   command.WaveLength = 10
   command.Angle = 0
   command.FillColor = New RasterColor(0, 0, 0)
   command.Flags = FreeHandWaveCommandFlags.Repeat Or FreeHandWaveCommandFlags.Frequency
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void FreeHandWaveCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   Point[] UserPoint = new Point[4]; 
   int[]   Amplitudes = new int[13]; 
 
   FreeHandWaveCommand command = new FreeHandWaveCommand(); 
 
   // Fill UserPoint array with points that define a triangular wave 
   UserPoint[0].X = 0; 
   UserPoint[0].Y = 0; 
   UserPoint[1].X = 3; 
   UserPoint[1].Y = 10; 
   UserPoint[2].X = 9; 
   UserPoint[2].Y = -10; 
   UserPoint[3].X = 12; 
   UserPoint[3].Y = 0; 
 
   //Draw a triangular wave according to UserPoint points and store the Amplitudes values in the Amplitudes array. 
   EffectsUtilities.GetCurvePoints(Amplitudes, UserPoint, CurvePointsType.Linear); 
 
   command.Amplitudes = Amplitudes; 
   command.Scale = 100; 
   command.WaveLength = 10; 
   command.Angle = 0; 
   command.FillColor = new RasterColor(0, 0, 0); 
   command.Flags = FreeHandWaveCommandFlags.Repeat | FreeHandWaveCommandFlags.Frequency; 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • The command applies the wave in the amplitudes array. You can repeat and rotate the wave in any direction. The amplitudes data can be obtained from the GetCurvePoints utility method.
  • If the image has a region, the effect will be applied on the region only.
  • 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.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.SpecialEffects.FreeHandWaveCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also