Click or drag to resize

TransformChainCommand Class

This command allows you to combine multiple transforms into a single command call.

Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessing.TransformsTransformChainCommand

Namespace:  Atalasoft.Imaging.ImageProcessing.Transforms
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class TransformChainCommand : ImageCommand, 
	ICollection, IEnumerable, ISerializable

The TransformChainCommand type exposes the following members.

Constructors
  NameDescription
Public methodTransformChainCommand
Creates a new instance of TransformChainCommand.
Public methodTransformChainCommand(Color)
Creates a new instance of TransformChainCommand specifying the background color of the resulting image.
Public methodTransformChainCommand(Transform)
Creates a new instance of TransformChainCommand specifying the transforms.
Public methodTransformChainCommand(Color, InterpolationMode)
Creates a new instance of TransformChainCommand specifying the background color and transform mode.
Protected methodTransformChainCommand(SerializationInfo, StreamingContext)
Creates a new instance of TransformChainCommand from serialization information
Public methodTransformChainCommand(Color, InterpolationMode, Transform)
Creates a new instance of TransformChainCommand specifying the background color, transform mode and a collection of transforms to apply.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyBackColor
Gets or sets the background color to use on newly uncovered areas of the image.
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyCount
Returns the number of transforms in the collection.
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Inherited from ImageCommand.)
Public propertyIsSynchronized
Gets a value indicating whether access to the transforms collection is synchronized.
Public propertyProgress
Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
(Inherited from ImageCommand.)
Public propertySupportedPixelFormats
Returns an array of PixelFormats supported by this command.
(Overrides ImageCommandSupportedPixelFormats.)
Public propertySyncRoot
Gets an object that can be used to synchronize access to the transforms collection.
Public propertyTransformMode
Gets or sets the InterpolationMode of this transform.
Top
Methods
  NameDescription
Public methodAdd
Adds a transform to the collection.
Public methodApply
Apply the command to the given image.
(Inherited from ImageCommand.)
Public methodApplyToImage Obsolete.
Applies the command to the source AtalaImage.
(Inherited from ImageCommand.)
Public methodClear
Removes all of the transforms from the collection.
Protected methodConstructChangedSourceImage
The method is called by the default implementation of Apply. It determines if it is necessary to create a copy of the source image in a different pixel format and if so, determines the best new pixel format and allocates that image.
(Inherited from ImageCommand.)
Protected methodConstructFinalImage
Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
(Inherited from ImageCommand.)
Protected methodConstructImageResults
Constructs the results object for this command.
(Inherited from ImageCommand.)
Public methodCopyTo(Array, Int32)
Copies transforms from the internal collection to an array.
Public methodCopyTo(Transform, Int32)
Copies transforms from the internal collection to an array.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetChangedPixelFormat
This method is called to change the pixel format of the source image.
(Inherited from ImageCommand.)
Public methodGetEnumerator
This allows the use of foreach statements on the transforms collection.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Fills a SerializationInfo object with information about this command.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodImageCommandGetObjectData
Aggregates ImageCommand data into the supplied SerializationInfo object.
(Inherited from ImageCommand.)
Public methodIsPixelFormatSupported
Returns a value indicating if the specified pixel format is supported.
(Inherited from ImageCommand.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformActualCommand
PerformActualCommand does the actual work of the image processing command.
(Overrides ImageCommandPerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
Protected methodSelectBestAlternatePixelFormat
Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
(Inherited from ImageCommand.)
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
(Overrides ImageCommandSelectPreferredPixelFormat(AtalaImage, PixelFormat, PixelFormat).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyImage
Verify the integrity of an AtalaImage.
(Inherited from ImageCommand.)
Protected methodVerifyProperties
Verify the integrity of properties in the command before processing an image.
(Overrides ImageCommandVerifyProperties(AtalaImage).)
Top
Remarks
This method requires a continuous tone image. If the source image is not continuous, it will attempt to convert the image into one.
Examples
Using TransformChain (C#)
// Load a 24-bit image.
AtalaImage image = new AtalaImage(@"D:\Test Images\1.jpg");

// Create the TransformChainCommand and add a couple transforms to it.
TransformChainCommand cmd = new TransformChainCommand();
cmd.Add(new MarbleTransform(0.4, new Size(10, 10)));
cmd.Add(new LensTransform(100, Point.Empty));

// Apply the transform.
AtalaImage result = cmd.Apply(image).Image;
image.Dispose();
Using TransformChain (Visual Basic)
' Load a 24-bit image.
Dim image As AtalaImage =  New AtalaImage("D:\Test Images\1.jpg") 

' Create the TransformChainCommand and add a couple transforms to it.
Dim cmd As TransformChainCommand =  New TransformChainCommand() 
cmd.Add(New MarbleTransform(0.4, New Size(10, 10)))
cmd.Add(New LensTransform(100,PoInteger.Empty))

' Apply the transform.
Dim result As AtalaImage =  cmd.Apply(image).Image
image.Dispose()
See Also