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



amplitude
An integer that represents the magnitude of the wave. Valid values range from 0 to 100.
waveLength
Value that represents the wave length, if the RadialWaveCommand.Period flag is set. Possible values range from 1 - 100 and give the wavelength as a percentage of the image dimensions. If the RadialWaveCommand.Frequency flag is set, this value is the number of repeated waves.
phase
Wave phase shift, in hundredths of degrees. The valid range is from -36000 to 36000 (The value in degrees is nPhase divided by 100).
centerPoint
Point from which the wave radiates.
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.
Initializes a new RadialWaveCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration)  
Public Function New( _
   ByVal amplitude As Integer, _
   ByVal waveLength As Integer, _
   ByVal phase As Integer, _
   ByVal centerPoint As Point, _
   ByVal fillColor As RasterColor, _
   ByVal flags As RadialWaveCommandFlags _
)
Visual Basic (Usage) Copy Code
Dim amplitude As Integer
Dim waveLength As Integer
Dim phase As Integer
Dim centerPoint As Point
Dim fillColor As RasterColor
Dim flags As RadialWaveCommandFlags
 
Dim instance As RadialWaveCommand(amplitude, waveLength, phase, centerPoint, fillColor, flags)
C#  
public RadialWaveCommand( 
   int amplitude,
   int waveLength,
   int phase,
   Point centerPoint,
   RasterColor fillColor,
   RadialWaveCommandFlags flags
)
C++/CLI  
public:
RadialWaveCommand( 
   int amplitude,
   int waveLength,
   int phase,
   Point centerPoint,
   RasterColor fillColor,
   RadialWaveCommandFlags flags
)

Parameters

amplitude
An integer that represents the magnitude of the wave. Valid values range from 0 to 100.
waveLength
Value that represents the wave length, if the RadialWaveCommand.Period flag is set. Possible values range from 1 - 100 and give the wavelength as a percentage of the image dimensions. If the RadialWaveCommand.Frequency flag is set, this value is the number of repeated waves.
phase
Wave phase shift, in hundredths of degrees. The valid range is from -36000 to 36000 (The value in degrees is nPhase divided by 100).
centerPoint
Point from which the wave radiates.
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.

Example

Run the RadialWaveCommand on an image.

Visual Basic Copy Code
Public Sub RadialWaveConstructorExample()
   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 RadialWaveCommand = New RadialWaveCommand(5, 25, 0, New Point(CType((leadImage.Width / 2), Integer), CType((leadImage.Height / 2), Integer)), New RasterColor(0, 0, 0), RadialWaveCommandFlags.Repeat Or RadialWaveCommandFlags.Frequency)
   ' Apply zoom wave from center of 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 RadialWaveConstructorExample() 

   // 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 
   RadialWaveCommand command = new RadialWaveCommand(5, 25, 0, new Point(image.Width / 2, image.Height / 2), new RasterColor(0, 0, 0), RadialWaveCommandFlags.Repeat | RadialWaveCommandFlags.Frequency); 
   // Apply zoom wave from center of 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