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



amplitude
Wave magnitude, in pixels. This parameter only accepts positive values.
frequency
Number of repeated waves. This parameter only accepts positive values.
lowerTransparency
Flag that indicates the transparency direction. Possible values are:
Value Meaning
TRUE Transparency increases as you move from the bottom of the image to the top of the image, line by line.
FALSE Transparency increases as you move from the top of the image to the bottom of the image, line by line.
Initializes a new OceanCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration)  
Public Function New( _
   ByVal amplitude As Integer, _
   ByVal frequency As Integer, _
   ByVal lowerTransparency As Boolean _
)
Visual Basic (Usage) Copy Code
Dim amplitude As Integer
Dim frequency As Integer
Dim lowerTransparency As Boolean
 
Dim instance As OceanCommand(amplitude, frequency, lowerTransparency)
C#  
public OceanCommand( 
   int amplitude,
   int frequency,
   bool lowerTransparency
)
C++/CLI  
public:
OceanCommand( 
   int amplitude,
   int frequency,
   bool lowerTransparency
)

Parameters

amplitude
Wave magnitude, in pixels. This parameter only accepts positive values.
frequency
Number of repeated waves. This parameter only accepts positive values.
lowerTransparency
Flag that indicates the transparency direction. Possible values are:
Value Meaning
TRUE Transparency increases as you move from the bottom of the image to the top of the image, line by line.
FALSE Transparency increases as you move from the top of the image to the bottom of the image, line by line.

Example

Run the OceanCommand on an image.

Visual Basic Copy Code
Public Sub OceanConstructorExample()
   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 OceanCommand = New OceanCommand(20, 6, True)
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void OceanConstructorExample() 
{ 
   // 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 
   OceanCommand command = new OceanCommand(20, 6, true); 
   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