Click or drag to resize

OffsetTransform Class

Moves the image on the canvas by a specified number of pixels.
Inheritance Hierarchy

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
public class OffsetTransform : Transform, 
	ISerializable

The OffsetTransform type exposes the following members.

Constructors
  NameDescription
Public methodOffsetTransform
Creates a new instance of OffsetTransform.
Public methodOffsetTransform(Point, OffsetTransformMode)
Creates a new instance of OffsetTransform specifying offset and offsetMode.
Protected methodOffsetTransform(SerializationInfo, StreamingContext)
Creates a new instance of OffsetTransform from serialization information
Public methodOffsetTransform(Point, OffsetTransformMode, InterpolationMode)
Creates a new instance of OffsetTransform specifying offset, offsetMode and transformMode.
Public methodOffsetTransform(Point, OffsetTransformMode, InterpolationMode, Color)
Creates a new instance of OffsetTransform specifying offset, offsetMode, transformMode and backColor.
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 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 propertyOffset
Gets or set the new left, top position for the image.
Public propertyOffsetMode
Gets or sets the style of OffsetTransformMode to perform.
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.
(Inherited from Transform.)
Public propertyTransformMode
Gets or sets the InterpolationMode of this transform.
Top
Methods
  NameDescription
Public methodAddToChain
Adds this transform to the transforms chain.
(Overrides TransformAddToChain(Int32, Int32).)
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.)
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 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 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 methodSelectCompatibleBackgroundColor
Returns a color value compatible with the image.
(Inherited from Transform.)
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
(Inherited from Transform.)
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.
(Inherited from Transform.)
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
Offset Example (C#)
// Load a 24-bit image.
AtalaImage image = new AtalaImage(@"D:\Test Images\1.jpg");

// Use the OffsetTransform to reposition the image.
OffsetTransform cmd = new OffsetTransform(new Point(image.Width / 2, image.Height / 2), OffsetTransformMode.DontWrapEdges);
AtalaImage result = cmd.Apply(image).Image;

image.Dispose();
Offset Example (Visual Basic)
' Load a 24-bit image.
Dim image As AtalaImage = New AtalaImage("D:\Test Images\1.jpg") 

' Use the OffsetTransform to reposition the image.
Dim cmd As OffsetTransform = New OffsetTransform(New Point(image.Width / 2,image.Height / 2),OffsetTransformMode.DontWrapEdges) 
Dim result As AtalaImage = cmd.Apply(image).Image

image.Dispose()
See Also