ScribbleCommand Class

Generate an image that looks like it was drawn with paint and a heavy outline pen.

Inheritance Hierarchy

System.Object
Atalasoft.Imaging.ImageProcessing.ImageCommand
Atalasoft.Imaging.ImageProcessing.Effects.ScribbleCommand

Namespace: Atalasoft.Imaging.ImageProcessing.Effects
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
public class ScribbleCommand : ImageCommand, 
	ISerializable

<SerializableAttribute>
Public Class ScribbleCommand
	Inherits ImageCommand
	Implements ISerializable

The ScribbleCommand type exposes the following members.

Constructors

	Name	Description
	ScribbleCommand()	Creates a new instance of ScribbleCommand.
	ScribbleCommand(SerializationInfo, StreamingContext)	Creates a new instance of ScribbleCommand from serialization information.
	ScribbleCommand(ScribbleMode, Boolean, Int32)	Creates a new instance of ScribbleCommand specifying the mode, darkness and whether the filter should be applied before the effect.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	Darkness	Gets or sets the darkness of the lines used for scribbling.
	FilterFirst	Gets or sets whether or not a filter should be applied to the image before the strokes.
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image. (Inherited from ImageCommand.)
	Mode	Gets or sets the ScribbleMode for the command.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	SupportedPixelFormats	Returns an array of PixelFormats supported by this command. (Overrides ImageCommand.SupportedPixelFormats.)

Top

Methods

	Name	Description
	Apply	Apply the command to the given image. (Inherited from ImageCommand.)
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage. (Inherited from ImageCommand.)
	ConstructChangedSourceImage	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. (Overrides ImageCommand.ConstructChangedSourceImage(AtalaImage).)
	ConstructFinalImage	Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command. (Overrides ImageCommand.ConstructFinalImage(AtalaImage).)
	ConstructImageResults	Constructs the results object for this command. (Inherited from ImageCommand.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetChangedPixelFormat	This method is called to change the pixel format of the source image. (Inherited from ImageCommand.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Fills the SerializationInfo object with information for this command.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageCommandGetObjectData	Aggregates ImageCommand data into the supplied SerializationInfo object. (Inherited from ImageCommand.)
	IsPixelFormatSupported	Returns a value indicating if the specified pixel format is supported. (Inherited from ImageCommand.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformActualCommand	PerformActualCommand does the actual work of the image processing command. (Overrides ImageCommand.PerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
	SelectBestAlternatePixelFormat	Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable. (Inherited from ImageCommand.)
	SelectPreferredPixelFormat	Chooses a pixel format that is preferred for this command. (Inherited from ImageCommand.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyImage	Verify the integrity of an AtalaImage. (Inherited from ImageCommand.)
	VerifyProperties	Verify the integrity of properties in the command before processing an image. (Overrides ImageCommand.VerifyProperties(AtalaImage).)

Top

Remarks

This method requires a continuous tone image. If the source image is not continuous, it will raise the ChangePixelFormat event and convert the image to a continuous tone format, which can be 8-bit grayscale, RGB, or RGBA.

Reference

Atalasoft.Imaging.ImageProcessing.Effects Namespace