com.aspose.psd.masking.options

Class MaskingOptions

java.lang.Object

com.aspose.psd.masking.options.MaskingOptions

Direct Known Subclasses:

GraphCutMaskingOptions

public class MaskingOptions
extends Object

Represents the common image masking options.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKGROUND_OBJECT_NUMBER The background object number

Constructor Summary

Constructors

Constructor and Description
MaskingOptions()

Method Summary

Modifier and Type	Method and Description
IMaskingArgs	getArgs() Gets the arguments for segmentation algorithm.
Color	getBackgroundReplacementColor() Gets the background replacement color.
boolean	getDecompose() Gets a value indicating whether needless to separate each Shape from mask as individual object or as united object from mask separated from background.
ImageOptionsBase	getExportOptions() Gets the image export options.
Rectangle	getMaskingArea() Gets the masking area.
int	getMethod() Gets the segmentation method.
void	setArgs(IMaskingArgs value) Sets the arguments for segmentation algorithm.
void	setBackgroundReplacementColor(Color value) Sets the background replacement color.
void	setDecompose(boolean value) Sets a value indicating whether needless to separate each Shape from mask as individual object or as united object from mask separated from background.
void	setExportOptions(ImageOptionsBase value) Sets the image export options.
void	setMaskingArea(Rectangle value) Sets the masking area.
void	setMethod(int value) Sets the segmentation method.

Field Detail

BACKGROUND_OBJECT_NUMBER

public static final int BACKGROUND_OBJECT_NUMBER

The background object number

See Also:

Constant Field Values

Constructor Detail

MaskingOptions

public MaskingOptions()

Method Detail

getMethod

public final int getMethod()

Gets the segmentation method.

Value: The segmentation method.

Returns:

the segmentation method.

setMethod

public final void setMethod(int value)

Sets the segmentation method.

Value: The segmentation method.

Parameters:

value - the segmentation method.

getArgs

public final IMaskingArgs getArgs()

Gets the arguments for segmentation algorithm.

Value: The arguments for segmentation algorithm.

Returns:

the arguments for segmentation algorithm.

setArgs

public final void setArgs(IMaskingArgs value)

Sets the arguments for segmentation algorithm.

Value: The arguments for segmentation algorithm.

Parameters:

value - the arguments for segmentation algorithm.

getExportOptions

public final ImageOptionsBase getExportOptions()

Gets the image export options.

Value: The image export options that will be used to create the resulting images.

Returns:

the image export options.

setExportOptions

public final void setExportOptions(ImageOptionsBase value)

Sets the image export options.

Value: The image export options that will be used to create the resulting images.

Parameters:

value - the image export options.

getMaskingArea

public final Rectangle getMaskingArea()

Gets the masking area.

Value: The masking area which is a partial area of the source image. Rectangle.Empty value means full source image area.

Returns:

the masking area.

setMaskingArea

public final void setMaskingArea(Rectangle value)

Sets the masking area.

Value: The masking area which is a partial area of the source image. Rectangle.Empty value means full source image area.

Parameters:

value - the masking area.

getDecompose

public final boolean getDecompose()

Gets a value indicating whether needless to separate each Shape from mask as individual object or as united object from mask separated from background.

Value: true if decompose; otherwise, false.

Returns:

a value indicating whether needless to separate each Shape from mask as individual object or as united object from mask separated from background.

setDecompose

public final void setDecompose(boolean value)

Sets a value indicating whether needless to separate each Shape from mask as individual object or as united object from mask separated from background.

Value: true if decompose; otherwise, false.

Parameters:

value - a value indicating whether needless to separate each Shape from mask as individual object or as united object from mask separated from background.

getBackgroundReplacementColor

public final Color getBackgroundReplacementColor()

Gets the background replacement color.

Value: The background replacement color. This color will be used as background color in resulting images.

Returns:

the background replacement color.

setBackgroundReplacementColor

public final void setBackgroundReplacementColor(Color value)

Sets the background replacement color.

Value: The background replacement color. This color will be used as background color in resulting images.

Parameters:

value - the background replacement color.