LEADTOOLS Image Processing (Leadtools.ImageProcessing.SpecialEffects assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
FunctionalLightCommandFlags Enumeration
See Also  
Leadtools.ImageProcessing.SpecialEffects Namespace : FunctionalLightCommandFlags Enumeration



Enumeration used to determine which function will be applied to the image, FreeHandLight, Free Light, or Trigonometry Light.

Syntax

Visual Basic (Declaration) 
<FlagsAttribute()>
Public Enum FunctionalLightCommandFlags 
   Inherits System.Enum
   Implements IComparableIConvertibleIFormattable 
Visual Basic (Usage)Copy Code
Dim instance As FunctionalLightCommandFlags
C# 
[FlagsAttribute()]
public enum FunctionalLightCommandFlags : System.Enum, IComparableIConvertibleIFormattable  
C++/CLI 
[FlagsAttribute()]
public enum class FunctionalLightCommandFlags : public System.Enum, IComparableIConvertibleIFormattable  

Members

MemberDescription
AdditionThe amplitude values are multiplied with the results of the selected function (sine, cosine, freehand). The results are then added to the pixel values of the equivalent channel. These functions as well as the real buffer values are from -1 to 1. This flag is valid only if Trigonometry or Freehand are also set.
CirclesSine or cosine function will generate the light as circles around the center. The center can be found in the Origin property, or the origin parameter of the Constructor. This flag is valid only if Trigonometry is also set.
FreehandIf this flag is set, the user will pass the light shape in the Buffer property of the FunctionalLightCommand class or the buffer parameter of the Constructor for the FunctionalLightCommand class. If this flag is set, the angle and buffer information will be used. The Angle property, or angle parameter, will determine the angle of the light lines compared to the X axis. If this flag is set, do not set LinearQuadratic or Trigonometry.
LinearInnerThe light will be concentrated at the center and will decrease outwards. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
LinearOuterThe light will be concentrated at the far points from the center and will decrease inwards towards the center. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
LinearQuadraticIf this flag is set, the light will be computed according to the distance from the center, which is in the Origin property or the origin parameter in the Constructor of the FunctionalLightCommand class. The brightness increase for every pixel is proportional to the distance to the effect's center. If this flag is set, do not set Trigonometry or Freehand.
MultiplyMultiply the color factor specified by the RedAmplitude property of the FunctionalLightCommand class, or the redAmplitude parameter of the Constructor, with the results of the selected function (sine, cosine, freehand). The results are multiplied with every channel value. This flag is valid only if Trigonometry or Freehand are also set.
NoneNo Flags selected.
QuadraticInnerThe light will be concentrated at the center and will decrease outwards. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
QuadraticOuterThe light will be concentrated at the far points from the center and will decrease inwards towards the center. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
TrigonometryIf this flag is set then the light will be generated by a sine or cosine function. If this is set, the frequency, angle and origin information are used to compute the light. If this flag is set, do not set LinearQuadratic or Freehand.
UnidirectionA sine or cosine function will generate the light as lines.
This flag is valid only if Trigonometry is also set. The lines are parallel and have no center. The Angle property of the FunctionalLightCommand class or the angle parameter of the Constructor determines the angle formed by these lines with the X axis.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         Leadtools.ImageProcessing.SpecialEffects.FunctionalLightCommandFlags

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also