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

Summary

Initializes a new WaveCommand class object with explicit parameters.

Syntax

C++/CLI

Python

public WaveCommand( 
   int amplitude, 
   int waveLength, 
   int angle, 
   int horizontalFactor, 
   int verticalFactor, 
   RasterColor fillColor, 
   WaveCommandFlags flags 
)

public: 
WaveCommand(  
   int amplitude, 
   int waveLength, 
   int angle, 
   int horizontalFactor, 
   int verticalFactor, 
   RasterColor fillColor, 
   WaveCommandFlags flags 
)

__init__(self,amplitude,waveLength,angle,horizontalFactor,verticalFactor,fillColor,flags) # Overloaded constructor

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.

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:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

WaveCommand Class

WaveCommand Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies