RingEffectCommand Constructor(LeadPoint,int,int,int,RasterColor,int,RingEffectCommandFlags)

Summary

Initializes a new RingEffectCommand class object with explicit parameters.

Syntax

C++/CLI

Python

public RingEffectCommand( 
   LeadPoint origin, 
   int radius, 
   int ringCount, 
   int randomize, 
   RasterColor color, 
   int angle, 
   RingEffectCommandFlags flags 
)

public: 
RingEffectCommand(  
   LeadPoint origin, 
   int radius, 
   int ringCount, 
   int randomize, 
   RasterColor color, 
   int angle, 
   RingEffectCommandFlags flags 
)

__init__(self,origin,radius,ringCount,randomize,color,angle,flags) # Overloaded constructor

Parameters

origin
Represents the coordinates (in pixels) for the origin of the rings. Only positive values are accepted.

radius
If the RingEffectCommandFlags.Radius flag is set, this is the width of each ring, in pixels. If the RingEffectCommandFlags.MaxRadius flag is set, this is the maximum radius, in pixels. In this latter case, the width of each ring is equal to ((radius) / (ringCount + 1)). Only positive values are accepted.

ringCount
Number of rings. Only positive values are accepted.

randomize
The starting point for the randomization process. Valid range is 0-500. If 0, the command will pick the starting point. If > 0, this value will be the starting point. Only positive values are accepted.

color
Color used to fill the undefined area. This parameter is used only if the RingEffectCommandFlags.Color flag is set.

angle
The rotation angle value for each ring compared to the inner ring, in hundredths of degrees. This parameter is used only if the RingEffectCommandFlags.FixedAngle flag. The range of the acceptable values is from -18000 to 18000. This value is divided internally by 100.

flags
Flags which control the behavior of this command. These flags can be OR-ed together, unless otherwise specified.

Example

Run the RingEffectCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
 
public void RingEffectConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, @"ImageProcessingDemo\Image2.jpg")); 
 
   // Prepare the command 
   LeadPoint origin = new LeadPoint((image.Width / 2), (image.Height / 2)); 
   RingEffectCommand command = new RingEffectCommand(origin, origin.X, 10, 0, new RasterColor(0, 0, 0), 100, RingEffectCommandFlags.Color | RingEffectCommandFlags.FixedAngle | RingEffectCommandFlags.MaxRadius); 
   // Apply a ring effect to this image with origin (Origin). The maximum ring radius is equal to half of the image's width. Draw 10 rings, fill the undefined areas with the Black color and the shift angle is equal to 1 degrees. 
   // Note that you will have undefined areas only if the image width is greater than the image height. 
   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

RingEffectCommand Class

RingEffectCommand Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29