←Select platform

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

Summary

Initializes a new RippleCommand class object with explicit parameters.

Syntax
C#
VB
C++
  
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 _ 
) 
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.

Example

Run the RippleCommand on an image.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void RippleConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // 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"; 
} 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
 
Public Sub RippleConstructorExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")) 
 
   ' 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 

Requirements

Target Platforms

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.ImageProcessing.SpecialEffects Assembly