Leadtools.ImageProcessing.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
RippleCommand Constructor(Int32,Int32,Int32,Int32,Point,RasterColor,RippleCommandType)
See Also  Example
Leadtools.ImageProcessing.SpecialEffects Namespace > RippleCommand Class > RippleCommand Constructor : RippleCommand Constructor(Int32,Int32,Int32,Int32,Point,RasterColor,RippleCommandType)



amplitude
Wave magnitude(amount of displacement). Only positive values are accepted.
frequency
Number of repeated waves along the radial line. Only positive values are accepted.
phase
Wave phase shift, in hundredths of degrees. The valid range is from -36000 to 36000 (The value in degrees is phase divided by 100).
attenuation
Attenuation value. The attenuation value indicates how rapidly the wave amplitude decays as the wave travels along the radial line. The values range from 0 - 1000.
centerPoint
The center of the Ripple wave.
fillColor
Specifies the fill color for any exposed areas.
type
Value that indicates how to handle exposed areas.
Initializes a new RippleCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration)  
Public Function New( _
   ByVal amplitude As Integer, _
   ByVal frequency As Integer, _
   ByVal phase As Integer, _
   ByVal attenuation As Integer, _
   ByVal centerPoint As Point, _
   ByVal fillColor As RasterColor, _
   ByVal type As RippleCommandType _
)
Visual Basic (Usage) Copy Code
Dim amplitude As Integer
Dim frequency As Integer
Dim phase As Integer
Dim attenuation As Integer
Dim centerPoint As Point
Dim fillColor As RasterColor
Dim type As RippleCommandType
 
Dim instance As RippleCommand(amplitude, frequency, phase, attenuation, centerPoint, fillColor, type)
C#  
public RippleCommand( 
   int amplitude,
   int frequency,
   int phase,
   int attenuation,
   Point centerPoint,
   RasterColor fillColor,
   RippleCommandType type
)
C++/CLI  
public:
RippleCommand( 
   int amplitude,
   int frequency,
   int phase,
   int attenuation,
   Point centerPoint,
   RasterColor fillColor,
   RippleCommandType type
)

Parameters

amplitude
Wave magnitude(amount of displacement). Only positive values are accepted.
frequency
Number of repeated waves along the radial line. Only positive values are accepted.
phase
Wave phase shift, in hundredths of degrees. The valid range is from -36000 to 36000 (The value in degrees is phase divided by 100).
attenuation
Attenuation value. The attenuation value indicates how rapidly the wave amplitude decays as the wave travels along the radial line. The values range from 0 - 1000.
centerPoint
The center of the Ripple wave.
fillColor
Specifies the fill color for any exposed areas.
type
Value that indicates how to handle exposed areas.

Example

Run the RippleCommand on an image.

Visual Basic Copy Code
Public Sub RippleConstructorExample()
   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(20, 10, 0, 0, New Point(leadImage.Width \ 2, leadImage.Height \ 2), New RasterColor(0, 0, 0), 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 RippleConstructorExample() 
{ 
   // 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(20, 10, 0, 0, new Point((image.Width / 2), (image.Height / 2)), new RasterColor(0,0,0), RippleCommandType.Repeat); 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

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