RippleCommand Constructor(Int32,Int32,Int32,Int32,LeadPoint,RasterColor,RippleCommandType)

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

public RippleCommand( 
   int amplitude,
   int frequency,
   int phase,
   int attenuation,
   LeadPoint centerPoint,
   RasterColor fillColor,
   RippleCommandType type
)

'Declaration
 
Public Function New( _
   ByVal amplitude As Integer, _
   ByVal frequency As Integer, _
   ByVal phase As Integer, _
   ByVal attenuation As Integer, _
   ByVal centerPoint As LeadPoint, _
   ByVal fillColor As RasterColor, _
   ByVal type As RippleCommandType _
)

'Usage
 
Dim amplitude As Integer
Dim frequency As Integer
Dim phase As Integer
Dim attenuation As Integer
Dim centerPoint As LeadPoint
Dim fillColor As RasterColor
Dim type As RippleCommandType
 
Dim instance As New RippleCommand(amplitude, frequency, phase, attenuation, centerPoint, fillColor, type)

public RippleCommand( 
   int amplitude,
   int frequency,
   int phase,
   int attenuation,
   LeadPoint centerPoint,
   RasterColor fillColor,
   RippleCommandType type
)

function RippleCommand( 
   amplitude ,
   frequency ,
   phase ,
   attenuation ,
   centerPoint ,
   fillColor ,
   type 
)

public:
RippleCommand( 
   int amplitude,
   int frequency,
   int phase,
   int attenuation,
   LeadPoint 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.

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

Public Sub RippleConstructorExample()
   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 command As RippleCommand = New RippleCommand(20, 10, 0, 0, New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2), New RasterColor(0, 0, 0), RippleCommandType.Repeat)
   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 RippleConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

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

      // Prepare the command
      RippleCommand command = new RippleCommand(20, 10, 0, 0, new LeadPoint((image.Width / 2), (image.Height / 2)), new RasterColor(0,0,0), RippleCommandType.Repeat);
      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 RippleConstructorExample()
{
   // 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
   RippleCommand command = new RippleCommand(20, 10, 0, 0, LeadPointHelper.Create((image.Width / 2), (image.Height / 2)), RasterColorHelper.Create(0,0,0), RippleCommandType.Repeat);
   command.Run(image);

   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);
}

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

RippleCommand Class
RippleCommand Members
Overload List