←Select platform

WaveCommand Constructor(int,int,int,int,int,RasterColor,WaveCommandFlags)

Summary

Initializes a new WaveCommand class object with explicit parameters.

Syntax
C#
VB
C++
  
Public Function New( _ 
   ByVal amplitude As Integer, _ 
   ByVal waveLength As Integer, _ 
   ByVal angle As Integer, _ 
   ByVal horizontalFactor As Integer, _ 
   ByVal verticalFactor As Integer, _ 
   ByVal fillColor As RasterColor, _ 
   ByVal flags As WaveCommandFlags _ 
) 
public: 
WaveCommand(  
   int amplitude, 
   int waveLength, 
   int angle, 
   int horizontalFactor, 
   int verticalFactor, 
   RasterColor fillColor, 
   WaveCommandFlags flags 
) 

Parameters

amplitude
Wave's magnitude. This parameter only accepts positive values.

waveLength
Value that represents the wave length, if theWaveCommandFlags.Period flag is set. Possible values range from 1 - 100 and give the wavelength as a percentage of the image dimensions. If the WaveCommandFlags.Frequency flag is set, this value is the number of repeated waves.

angle
Wave's rotation angle in hundredths of degrees. The valid range is from -18000 to 18000 (The value in degrees is angle divided by 100).

horizontalFactor
Size of the horizontal wave, given as a percentage. The valid range is from 0 to 100.

verticalFactor
Size of the vertical wave, given as a percentage. The valid range is from 0 to 100.

fillColor
Specifies the fill color for any exposed areas.

flags
Flags that indicate how to handle exposed areas, the type of information in the waveLength parameter and the wave type.

Example

Run the WaveCommand on an image.

C#
VB
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void WaveConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // Prepare the command 
   WaveCommand command = new WaveCommand(20, 25, 0, 100, 100, new RasterColor(0, 0, 0), WaveCommandFlags.Repeat | WaveCommandFlags.Period | WaveCommandFlags.SinWave); 
   // apply sinusoidal waves on the image. 
   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 WaveConstructorExample() 
   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 WaveCommand = New WaveCommand(20, 25, 0, 100, 100, New RasterColor(0, 0, 0), WaveCommandFlags.Repeat Or WaveCommandFlags.Period Or WaveCommandFlags.SinWave) 
   ' apply sinusoidal waves on the image. 
   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.11.25
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.ImageProcessing.SpecialEffects Assembly