VignnetCommand Constructor(LeadPoint,Int32,Int32,Int32,Int32,RasterColor,VignnetCommandFlags)

public VignnetCommand( 
   LeadPoint origin,
   int fading,
   int fadingRate,
   int width,
   int height,
   RasterColor vignetteColor,
   VignnetCommandFlags flags
)

'Declaration
 
Public Function New( _
   ByVal origin As LeadPoint, _
   ByVal fading As Integer, _
   ByVal fadingRate As Integer, _
   ByVal width As Integer, _
   ByVal height As Integer, _
   ByVal vignetteColor As RasterColor, _
   ByVal flags As VignnetCommandFlags _
)

'Usage
 
Dim origin As LeadPoint
Dim fading As Integer
Dim fadingRate As Integer
Dim width As Integer
Dim height As Integer
Dim vignetteColor As RasterColor
Dim flags As VignnetCommandFlags
 
Dim instance As New VignnetCommand(origin, fading, fadingRate, width, height, vignetteColor, flags)

public VignnetCommand( 
   LeadPoint origin,
   int fading,
   int fadingRate,
   int width,
   int height,
   RasterColor vignetteColor,
   VignnetCommandFlags flags
)

function VignnetCommand( 
   origin ,
   fading ,
   fadingRate ,
   width ,
   height ,
   vignetteColor ,
   flags 
)

public:
VignnetCommand( 
   LeadPoint origin,
   int fading,
   int fadingRate,
   int width,
   int height,
   RasterColor vignetteColor,
   VignnetCommandFlags flags
)

Parameters

origin

Center point for all vignette objects (circle, ellipse, rectangle, and square).

fading

Represents the percent of feathering in towards or outward from the vignette object. Negative values mean that the feathering will start outside the boundaries of the object and increase toward the object. Positive values mean that the feathering will start on the boundaries of the object and increase away from the object. Possible values range from -100 to 100.

fadingRate

Represents the value that indicates the fading rate. This value is used to controlling the fading process. It will be divided by 100 internally. The valid range is from 0 to 100.

width

Represents the value that indicates the dimension of the vignette object in pixels.

height

Represents the value that indicates the height in pixels of the vignette ellipse or rectangle objects.This property is ignored if the VignnetCommandFlags.Circle or VignnetCommandFlags.Square flag is set.

vignetteColor

Represents the value that specifies the vignette object color.

flags

Enumeration that specifies how to apply the Vignnet effect.

Run the VignnetCommand on an image.

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

Copy Code  

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.SpecialEffects

<TestMethod()> _
Public Sub VignnetConstructorExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP"))

   ' Prepare the command
   Dim command As VignnetCommand = New VignnetCommand(New LeadPoint(leadImage.Width \ 2, leadImage.Height \ 2), 50, 100, 20, 20, New RasterColor(0, 0, 0), VignnetCommandFlags.Ellipse Or VignnetCommandFlags.Fillin)
   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

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.SpecialEffects;

[TestMethod]
public void VignnetConstructorExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP"));

   // Prepare the command
   VignnetCommand command = new VignnetCommand(new LeadPoint((image.Width / 2), (image.Height / 2)), 50, 100, 20, 20, new RasterColor(0, 0, 0), VignnetCommandFlags.Ellipse | VignnetCommandFlags.Fillin);
   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";
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.SpecialEffects;

[TestMethod]
public async Task VignnetConstructorExample()
{
   // 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
   VignnetCommand command = new VignnetCommand(LeadPointHelper.Create((image.Width / 2), (image.Height / 2)), 50, 100, 20, 20, RasterColorHelper.Create(0, 0, 0), VignnetCommandFlags.Ellipse | VignnetCommandFlags.Fillin);
   command.Run(image);

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

Target Platforms

Reference

VignnetCommand Class
VignnetCommand Members
Overload List