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



Warps the image in concentric rings. This command is available in the Raster Pro and above toolkits.

Syntax

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

Example

Run the RippleCommand on an image.

Visual Basic Copy Code
Public Sub RippleCommandExample()
   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 command As RippleCommand = New RippleCommand
   command.CenterPoint = New Point(leadImage.Width \ 2, leadImage.Height \ 2)
   command.Amplitude = 20
   command.Frequency = 10
   command.Phase = 0
   command.Attenuation = 0
   command.FillColor = New RasterColor(0, 0, 0)
   command.Type = RippleCommandType.Repeat
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void RippleCommandExample() 
{ 
   // 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 
   RippleCommand command = new RippleCommand(); 
   command.CenterPoint   = new Point((image.Width / 2), (image.Height / 2)); 
   command.Amplitude     = 20; 
   command.Frequency     = 10; 
   command.Phase         = 0; 
   command.Attenuation   = 0; 
   command.FillColor     = new RasterColor(0,0,0); 
   command.Type          = RippleCommandType.Repeat; 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • This command will warp the image as a series of rings radiating out from the center point. The center point must be defined inside the image or inside the region, if the image has a region.
  • 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 Introduction to Image Processing With LEADTOOLS.
For more information, refer to Applying Artistic Effects.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.SpecialEffects.RippleCommand

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