RippleCommand Constructor(int,int,int,int,LeadPoint,RasterColor,RippleCommandType)

Summary

Initializes a new RippleCommand class object with explicit parameters.

Syntax

C++/CLI

Python

public RippleCommand( 
   int amplitude, 
   int frequency, 
   int phase, 
   int attenuation, 
   LeadPoint centerPoint, 
   RasterColor fillColor, 
   RippleCommandType type 
)

public: 
RippleCommand(  
   int amplitude, 
   int frequency, 
   int phase, 
   int attenuation, 
   LeadPoint centerPoint, 
   RasterColor fillColor, 
   RippleCommandType type 
)

__init__(self,amplitude,frequency,phase,attenuation,centerPoint,fillColor,type) # Overloaded constructor

Parameters

amplitude
Wave magnitude(amount of displacement). Only positive values are accepted.

frequency
Number of repeated waves along the radial line. Only positive values are accepted.

phase
Wave phase shift, in hundredths of degrees. The valid range is from -36000 to 36000 (The value in degrees is phase divided by 100).

attenuation
Attenuation value. The attenuation value indicates how rapidly the wave amplitude decays as the wave travels along the radial line. The values range from 0 - 1000.

centerPoint
The center of the Ripple wave.

fillColor
Specifies the fill color for any exposed areas.

type
Value that indicates how to handle exposed areas.

Example

Run the RippleCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
 
public void RippleConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // Prepare the command 
   RippleCommand command = new RippleCommand(20, 10, 0, 0, new LeadPoint((image.Width / 2), (image.Height / 2)), new RasterColor(0, 0, 0), RippleCommandType.Repeat); 
   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

RippleCommand Class

RippleCommand 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