FunctionalLightCommand Constructor(int,int,int,int,int,LeadPoint,int,FunctionalLightCommandFlags)

Summary

Initializes a new FunctionalLightCommand class object with explicit parameters.

Syntax

C++

public FunctionalLightCommand( 
   int frequency, 
   int redAmplitude, 
   int greenAmplitude, 
   int blueAmplitude, 
   int angle, 
   LeadPoint origin, 
   int phaseShift, 
   FunctionalLightCommandFlags flags 
)

  
Public Function New( _ 
   ByVal frequency As Integer, _ 
   ByVal redAmplitude As Integer, _ 
   ByVal greenAmplitude As Integer, _ 
   ByVal blueAmplitude As Integer, _ 
   ByVal angle As Integer, _ 
   ByVal origin As LeadPoint, _ 
   ByVal phaseShift As Integer, _ 
   ByVal flags As FunctionalLightCommandFlags _ 
)

public: 
FunctionalLightCommand(  
   int frequency, 
   int redAmplitude, 
   int greenAmplitude, 
   int blueAmplitude, 
   int angle, 
   LeadPoint origin, 
   int phaseShift, 
   FunctionalLightCommandFlags flags 
)

Parameters

frequency
Value that represents the frequency factor. This parameter is used if the FunctionalLightCommandFlags.Trigonometry flag or the FunctionalLightCommandFlags.Freehand flag is set. Valid values range from 1 - 10000. This value is divided internally by 100 (corresponding to a real interval of 0.01 - 100.0).

redAmplitude
If the image is grayscale, this parameter represents the amplitude of the master channel. If the image is color and the FunctionalLightCommandFlags.Multiply or FunctionalLightCommandFlags.LinearQuadratic flags are set, this parameter represents the amplitude of each channel. If the image is color and the FunctionalLightCommandFlags.Addition flag is used, this represents the amplitude of the red channel. This value is an integer with a value greater than or equal to 0. This value will be multiplied with the results of the selected function (sine, cosine, user buffer , _). The results of the multiplications are then added to the pixel values. These functions as well as the real buffer values are from -1 to 1. Possible values for this parameter are from 0-100.

greenAmplitude
Value that represents the amplitude of the green color when the addition operation is used (FunctionalLightCommandFlags.Addition flag is set). This value is ignored when grayscale images are used or when the multiplication operation is used (FunctionalLightCommandFlags.Multiply flag is set). This value is also ignored if the FunctionalLightCommandFlags.LinearQuadratic flag is set. flag. Possible values for this parameter are from 0 - 100.

blueAmplitude
Value that represents the amplitude of the blue color when the addition operation is used (FunctionalLightCommandFlags.Addition flag is set). This value is ignored when grayscale images are used or when the multiplication operation is used ( FunctionalLightCommandFlags.Multiply flag is set). This value is also ignored if the FunctionalLightCommandFlags.LinearQuadratic flag is set Possible values for this parameter are from 0 -100.

angle
Value that represents the angle, in hundredths of degrees. This parameter is used if the FunctionalLightCommandFlags.Trigonometry or to FunctionalLightCommandFlags.Freehand flag is set. Valid values for this parameter range from -18000 to 18000. This value is divided internally by 100.

origin
Represents the coordinates of the origin, in pixels.This parameter is used if the FunctionalLightCommandFlags.Trigonometry flag and FunctionalLightCommandFlags.Circles flag are set, or if the FunctionalLightCommandFlags.LinearQuadratic flag is set.

phaseShift
Value that represents the phase shift angle, in hundredths of degrees. This parameter is used if the FunctionalLightCommandFlags.Trigonometry flag is set. Possible values for this parameter are from -18000 to 18000. This value will be divided internally by 100.

flags
Flags that indicate the function applied to the image. For a list of the available flags, refer to FunctionalLightCommandFlags.

Example

Run the FunctionalLightCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
using Leadtools.ImageProcessing.Effects; 
 
public void FunctionalLightConstructorExample_S2() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")); 
 
   // Prepare the command 
   FunctionalLightCommand command = new FunctionalLightCommand(5000, 90, 50, 70, 5000, new LeadPoint(image.Width / 2, image.Height / 2), 2000, FunctionalLightCommandFlags.Trigonometry | FunctionalLightCommandFlags.Circles | 
         FunctionalLightCommandFlags.Addition); 
   // Apply the linear lighting effect. 
   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:\LEADTOOLS21\Resources\Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
Imports Leadtools.ImageProcessing.Effects 
 
Public Sub FunctionalLightConstructorExample_S2() 
   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 FunctionalLightCommand = New FunctionalLightCommand(5000, 90, 50, 70, 5000, New LeadPoint(CType((leadImage.Width / 2), Integer), CType((leadImage.Height / 2), Integer)), 2000, FunctionalLightCommandFlags.Trigonometry Or 
         FunctionalLightCommandFlags.Unidirection Or FunctionalLightCommandFlags.Addition) 
   ' Apply the linear lighting effect. 
   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:\LEADTOOLS21\Resources\Images" 
End Class

Requirements

Target Platforms

Reference

FunctionalLightCommand Class

FunctionalLightCommand Members

Overload List

Download our FREE evaluation

Help Version 21.0.2021.6.30

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies