Leadtools.ImageProcessing.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
VignnetCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.SpecialEffects Namespace : VignnetCommand Class



Draws a specified shape and feathers it to the image. This method is available in the Raster Pro and above toolkits.

Syntax

Visual Basic (Declaration)  
Public Class VignnetCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage) Copy Code
Dim instance As VignnetCommand
C#  
public class VignnetCommand : RasterCommand, IRasterCommand 
C++/CLI  
public ref class VignnetCommand : public RasterCommand, IRasterCommand 

Example

Run the VignnetCommand on an image.

Visual Basic Copy Code
Public Sub VignnetCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim command As VignnetCommand = New VignnetCommand
   command.Origin = New Point(leadImage.Width \ 2, leadImage.Height \ 2)
   command.Fading = 50
   command.FadingRate = 100
   command.Width = 20
   command.Height = 20
   command.VignetteColor = New RasterColor(0, 0, 0)
   command.Flags = VignnetCommandFlags.Ellipse Or VignnetCommandFlags.Fillin
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void VignnetCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   VignnetCommand command = new VignnetCommand(); 
   command.Origin        = new Point((image.Width/2),(image.Height/2)); 
   command.Fading        = 50; 
   command.FadingRate    = 100; 
   command.Width         = 20; 
   command.Height        = 20; 
   command.VignetteColor = new RasterColor(0,0,0); 
   command.Flags         = VignnetCommandFlags.Ellipse | VignnetCommandFlags.Fillin; 
 
   command.Run(image); 
   codecs.Save(image, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • This method can be used to draw a circle, ellipse, rectangle or square to create a vignette shape and then a color is feathered to the image, filling either the inside or the outside of the vignette shape.
  • This method supports 12- and 16-bit grayscale and 48- and 64-bit color images. Support for 12- and 16-bit grayscale and 48- and 64-bit color images is available only in the Document/Medical toolkits.
  • This method does not support signed data images.
  • This command does not support 32-bit grayscale images.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.SpecialEffects.VignnetCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also