Click or drag to resize

BevelEdgeCommand Class

Apply a bevel effect to the edges of an image.

Inheritance Hierarchy
System.Object
  Atalasoft.Imaging.ImageProcessing.ImageCommand
    Atalasoft.Imaging.ImageProcessing.Effects.BevelEdgeCommand

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
public class BevelEdgeCommand : ImageCommand, 
	ISerializable

The BevelEdgeCommand type exposes the following members.

Constructors
  NameDescription
Public methodBevelEdgeCommand()
Creates a new instance of BevelEdgeCommand.
Protected methodBevelEdgeCommand(SerializationInfo, StreamingContext)
Creates a new instance of BevelEdgeCommand from serialization information.
Public methodBevelEdgeCommand(Int32, Double, Double, Double, Double, Double)
Creates a new instance of BevelEdgeCommand specifying the bevel size and brightness levels.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyBevelSize
Gets or sets the size of the bevel along the edge, in pixels.
Public propertyBottomBrightness
Gets or sets the brightness level of the bottom facet. (0-255)
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.
(Overrides ImageCommand.InPlaceProcessing.)
Public propertyLeftBrightness
Gets or sets the brightness level of the left facet. (0-255)
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 propertyRightBrightness
Gets or sets the brightness level of the right facet. (0-255)
Public propertySmoothFactor
Gets or sets the smooth the bevel edge. (0-500)
Public propertySupportedPixelFormats
Returns an array of PixelFormats supported by this command.
(Overrides ImageCommand.SupportedPixelFormats.)
Public propertyTopBrightness
Gets or sets the brightness level of the top facet. (0-255)
Top
Methods
  NameDescription
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 the SerializationInfo object with information for 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 ImageCommand.PerformActualCommand(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.
(Inherited from ImageCommand.)
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 ImageCommand.VerifyProperties(AtalaImage).)
Top
Remarks
This method requires a continuous tone image.
Examples
BevelEdge Example (C#)
Copy
// Load a 24-bit image.
AtalaImage image = new AtalaImage(@"D:\Test Images\1.jpg");

// Apply a 10 pixel bevel with a light source from the right.
BevelEdgeCommand cmd = new BevelEdgeCommand(10, 60, 170, 200, 40, 200);
cmd.Apply(image);
BevelEdge Example (Visual Basic)
Copy
' Load a 24-bit image.
Dim image As AtalaImage =  New AtalaImage("D:\Test Images\1.jpg") 

' Apply a 10 pixel bevel with a light source from the right.
Dim cmd As BevelEdgeCommand =  New BevelEdgeCommand(10,60,170,200,40,200) 
cmd.Apply(image)
See Also