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



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.
Initializes a new WaveCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration)  
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 _
)
Visual Basic (Usage) Copy Code
Dim amplitude As Integer
Dim waveLength As Integer
Dim angle As Integer
Dim horizontalFactor As Integer
Dim verticalFactor As Integer
Dim fillColor As RasterColor
Dim flags As WaveCommandFlags
 
Dim instance As WaveCommand(amplitude, waveLength, angle, horizontalFactor, verticalFactor, fillColor, flags)
C#  
public WaveCommand( 
   int amplitude,
   int waveLength,
   int angle,
   int horizontalFactor,
   int verticalFactor,
   RasterColor fillColor,
   WaveCommandFlags flags
)
C++/CLI  
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.

Visual Basic Copy Code
Public Sub WaveConstructorExample()
   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 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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void WaveConstructorExample() 

   // 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 
   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, 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