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

Initializes a new RingEffectCommand class object with explicit parameters.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

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

'Declaration
 
Public Function New( _
   ByVal origin As LeadPoint, _
   ByVal radius As Integer, _
   ByVal ringCount As Integer, _
   ByVal randomize As Integer, _
   ByVal color As RasterColor, _
   ByVal angle As Integer, _
   ByVal flags As RingEffectCommandFlags _
)

'Usage
 
Dim origin As LeadPoint
Dim radius As Integer
Dim ringCount As Integer
Dim randomize As Integer
Dim color As RasterColor
Dim angle As Integer
Dim flags As RingEffectCommandFlags
 
Dim instance As New RingEffectCommand(origin, radius, ringCount, randomize, color, angle, flags)

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

function RingEffectCommand( 
   origin ,
   radius ,
   ringCount ,
   randomize ,
   color ,
   angle ,
   flags 
)

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

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

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub RingEffectConstructorExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))

   ' Prepare the command
   Dim origin As LeadPoint = New LeadPoint(CType((leadImage.Width \ 2), Integer), CType((leadImage.Height \ 2), Integer))
   Dim command As RingEffectCommand = New RingEffectCommand(origin, origin.X, 10, 0, New RasterColor(0, 0, 0), 100, RingEffectCommandFlags.Color Or RingEffectCommandFlags.FixedAngle Or 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(leadImage)
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24)

End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void RingEffectConstructorExample()
   {
      // Load an image
      RasterCodecs codecs = new RasterCodecs();
      codecs.ThrowExceptionsOnInvalidImages = true;

      RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.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:\Users\Public\Documents\LEADTOOLS Images";
}

[TestMethod]
public async Task RingEffectConstructorExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepare the command
   LeadPoint origin = LeadPointHelper.Create((image.Width / 2), (image.Height / 2));
   RingEffectCommand command = new RingEffectCommand(origin, origin.X, 10, 0, RasterColorHelper.Create(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);

   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RingEffectCommand Class
RingEffectCommand Members
Overload List