com.aspose.imaging.magicwand

Class MagicWandSettings

java.lang.Object

com.aspose.imaging.magicwand.MagicWandSettings

public class MagicWandSettings
extends Object

A magic wand selection settings class.

Code example:

The example shows how to select a simple area of an image based on tone and color of any pixel using Magic Wand tool.

String imageFilePath = "input.png";
String outputFilePath = "masked.png";
try (RasterImage image = (RasterImage)Image.load(imageFilePath))
{
    // Create a new mask using magic wand tool based on tone and color of pixel (120, 100) with custom threshold equal to 150
    MagicWandTool
            .select(image, new MagicWandSettings(120, 100) {{ setThreshold(150); }})
            // Apply mask to the image
            .apply();

    // Save image with forced transparency color type option
    image.save(outputFilePath, new PngOptions()
    {{
        setColorType(PngColorType.TruecolorWithAlpha);
    }});
}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MagicWandSettings.ColorComparison Delegate for Color comparison with a defined threshold.

Constructor Summary

Constructors

Constructor and Description
MagicWandSettings(int x, int y) Initializes a new instance of the MagicWandSettings class.
MagicWandSettings(Point point) Initializes a new instance of the MagicWandSettings class.

Method Summary

Modifier and Type	Method and Description
Rectangle	getAreaOfInterest() Gets the bounds of the area for algorithm work.
int	getColorCompareMode() Gets the algorithm how colors are compared.
MagicWandSettings.ColorComparison	getColorComparisonDelegate() Gets the custom color comparison algorithm if ColorCompareMode(MagicWandSettings.getColorCompareMode()/MagicWandSettings.setColorCompareMode(int)) is set to ColorComparisonMode.Custom.
boolean	getContiguousMode() Gets a value indicating whether magic wand will define only contiguous pixels.
int	getDirectionalMode() Gets the mode of flood fill search algorithm: four of eight direction search.
Point	getPoint() Gets the reference point for algorithm work.
int	getThreshold() Gets the tolerance level for pixels color comparison.
void	setAreaOfInterest(Rectangle value) Sets the bounds of the area for algorithm work.
void	setColorCompareMode(int value) Sets the algorithm how colors are compared.
void	setColorComparisonDelegate(MagicWandSettings.ColorComparison value) Sets the custom color comparison algorithm if ColorCompareMode(MagicWandSettings.getColorCompareMode()/MagicWandSettings.setColorCompareMode(int)) is set to ColorComparisonMode.Custom.
void	setContiguousMode(boolean value) Sets a value indicating whether magic wand will define only contiguous pixels.
void	setDirectionalMode(int value) Sets the mode of flood fill search algorithm: four of eight direction search.
void	setThreshold(int value) Sets the tolerance level for pixels color comparison.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MagicWandSettings

public MagicWandSettings(Point point)

Initializes a new instance of the MagicWandSettings class.

Parameters:

point - The reference point.

MagicWandSettings

public MagicWandSettings(int x,
                         int y)

Initializes a new instance of the MagicWandSettings class.

Parameters:

x - The x-coordinate of the reference point.

y - The y-coordinate of the reference point.

Method Detail

getAreaOfInterest

public final Rectangle getAreaOfInterest()

Gets the bounds of the area for algorithm work.

Value: The rectangle representing the bounds of the area of interest.

Returns:

the bounds of the area for algorithm work.

setAreaOfInterest

public final void setAreaOfInterest(Rectangle value)

Sets the bounds of the area for algorithm work.

Value: The rectangle representing the bounds of the area of interest.

Parameters:

value - the bounds of the area for algorithm work.

getPoint

public final Point getPoint()

Gets the reference point for algorithm work.

Value: The Point value.

Returns:

the reference point for algorithm work.

getThreshold

public final int getThreshold()

Gets the tolerance level for pixels color comparison.

Value: The threshold for color comparing.

Returns:

the tolerance level for pixels color comparison.

setThreshold

public final void setThreshold(int value)

Sets the tolerance level for pixels color comparison.

Value: The threshold for color comparing.

Parameters:

value - the tolerance level for pixels color comparison.

getContiguousMode

public final boolean getContiguousMode()

Gets a value indicating whether magic wand will define only contiguous pixels.

Value: true if the element is enabled; otherwise, false. The default value is true.

Returns:

a value indicating whether magic wand will define only contiguous pixels.

setContiguousMode

public final void setContiguousMode(boolean value)

Sets a value indicating whether magic wand will define only contiguous pixels.

Value: true if the element is enabled; otherwise, false. The default value is true.

Parameters:

value - a value indicating whether magic wand will define only contiguous pixels.

getDirectionalMode

public final int getDirectionalMode()

Gets the mode of flood fill search algorithm: four of eight direction search.

Value: The mode of flood fill search algorithm.

Returns:

the mode of flood fill search algorithm: four of eight direction search.

setDirectionalMode

public final void setDirectionalMode(int value)

Sets the mode of flood fill search algorithm: four of eight direction search.

Value: The mode of flood fill search algorithm.

Parameters:

value - the mode of flood fill search algorithm: four of eight direction search.

getColorCompareMode

public final int getColorCompareMode()

Gets the algorithm how colors are compared.

Value: The color compare mode.

Returns:

the algorithm how colors are compared.

setColorCompareMode

public final void setColorCompareMode(int value)

Sets the algorithm how colors are compared.

Value: The color compare mode.

Parameters:

value - the algorithm how colors are compared.

getColorComparisonDelegate

public final MagicWandSettings.ColorComparison getColorComparisonDelegate()

Gets the custom color comparison algorithm if ColorCompareMode(MagicWandSettings.getColorCompareMode()/MagicWandSettings.setColorCompareMode(int)) is set to ColorComparisonMode.Custom.

Value: The color compare delegate.

Returns:

the custom color comparison algorithm if ColorCompareMode(MagicWandSettings.getColorCompareMode()/MagicWandSettings.setColorCompareMode(int)) is set to ColorComparisonMode.Custom.

setColorComparisonDelegate

public final void setColorComparisonDelegate(MagicWandSettings.ColorComparison value)

Sets the custom color comparison algorithm if ColorCompareMode(MagicWandSettings.getColorCompareMode()/MagicWandSettings.setColorCompareMode(int)) is set to ColorComparisonMode.Custom.

Value: The color compare delegate.

Parameters:

value - the custom color comparison algorithm if ColorCompareMode(MagicWandSettings.getColorCompareMode()/MagicWandSettings.setColorCompareMode(int)) is set to ColorComparisonMode.Custom.