com.sun.scenario.effect

Class InvertMask

java.lang.Object

com.sun.scenario.effect.Effect

com.sun.scenario.effect.FilterEffect<T>

com.sun.scenario.effect.CoreEffect<RenderState>

com.sun.scenario.effect.InvertMask

public class InvertMask
extends CoreEffect<RenderState>

An effect that returns a mask that is the inverse of the input (i.e., opaque areas of the input become transparent and vice versa) with a given offset and padding.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.scenario.effect.Effect

Effect.AccelType

Field Summary

Fields

Modifier and Type	Field and Description
private int	pad
private int	xoff
private int	yoff

Fields inherited from class com.sun.scenario.effect.Effect

DefaultInput

Constructor Summary

Constructors

Constructor and Description
InvertMask() Constructs a new InvertMask effect with the default pad (10), using the default input for source data.
InvertMask(Effect input) Constructs a new InvertMask effect with the default pad (10), using the given Effect as the input.
InvertMask(int pad) Constructs a new InvertMask effect with the given pad value using the default input for source data.
InvertMask(int pad, Effect input) Constructs a new InvertMask effect with the given pad value and effect input.

Method Summary

Modifier and Type	Method and Description
BaseBounds	getBounds(BaseTransform transform, Effect defaultInput) Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect.
DirtyRegionContainer	getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool) Returns the dirty region container containing dirty regions affected by this filter operation.
Effect	getInput() Returns the input for this Effect.
int	getOffsetX() Returns the offset in the x direction, in pixels.
int	getOffsetY() Returns the offset in the y direction, in pixels.
int	getPad() Returns the amount of padding added to each side of the resulting image, in pixels.
RenderState	getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput) Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.
Rectangle	getResultBounds(BaseTransform transform, Rectangle outputClip, ImageData... inputDatas)
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setOffsetX(int xoff) Sets the offset in the x direction, in pixels.
void	setOffsetY(int yoff) Sets the offset in the y direction, in pixels.
void	setPad(int pad) Sets the amount of padding added to each side of the resulting image, in pixels.

Methods inherited from class com.sun.scenario.effect.CoreEffect

filterImageDatas, getAccelType, getPeer, updatePeerKey, updatePeerKey

Methods inherited from class com.sun.scenario.effect.FilterEffect

filter, transform, untransform, untransformClip

Methods inherited from class com.sun.scenario.effect.Effect

combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getDefaultedInput, getDefaultedInput, getInputs, getNumInputs, getState, releaseCompatibleImage, setInput, transformBounds

Methods inherited from class java.lang.Object

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

Field Detail

pad

private int pad

xoff

private int xoff

yoff

private int yoff

Constructor Detail

InvertMask

public InvertMask()

Constructs a new InvertMask effect with the default pad (10), using the default input for source data. This is a shorthand equivalent to:

     new InvertMask(10, DefaultInput)
 

InvertMask

public InvertMask(Effect input)

Constructs a new InvertMask effect with the default pad (10), using the given Effect as the input. This is a shorthand equivalent to:

     new InvertMask(10, input)
 

Parameters:

input - the single input Effect

InvertMask

public InvertMask(int pad)

Constructs a new InvertMask effect with the given pad value using the default input for source data.

Parameters:

pad - the amount of padding on each side of the resulting image

Throws:

java.lang.IllegalArgumentException - if pad is negative

InvertMask

public InvertMask(int pad,
                  Effect input)

Constructs a new InvertMask effect with the given pad value and effect input.

Parameters:

pad - the amount of padding on each side of the resulting image

input - the single input Effect

Throws:

java.lang.IllegalArgumentException - if pad is negative

Method Detail

getInput

public final Effect getInput()

Returns the input for this Effect.

Returns:

the input for this Effect

setInput

public void setInput(Effect input)

Sets the input for this Effect to a specific Effect or to the default input if input is null.

Parameters:

input - the input for this Effect

getPad

public int getPad()

Returns the amount of padding added to each side of the resulting image, in pixels.

Returns:

the amount of padding, in pixels

setPad

public void setPad(int pad)

Sets the amount of padding added to each side of the resulting image, in pixels.

       Min: 0
       Max: Integer.MAX_VALUE
   Default: 0
  Identity: 0
 

Parameters:

pad - the amount of padding, in pixels

Throws:

java.lang.IllegalArgumentException - if pad is negative

getOffsetX

public int getOffsetX()

Returns the offset in the x direction, in pixels.

Returns:

the offset in the x direction, in pixels.

setOffsetX

public void setOffsetX(int xoff)

Sets the offset in the x direction, in pixels.

       Min: Integer.MIN_VALUE
       Max: Integer.MAX_VALUE
   Default: 0
  Identity: 0
 

Parameters:

xoff - the offset in the x direction, in pixels

getOffsetY

public int getOffsetY()

Returns the offset in the y direction, in pixels.

Returns:

the offset in the y direction, in pixels.

setOffsetY

public void setOffsetY(int yoff)

Sets the offset in the y direction, in pixels.

       Min: Integer.MIN_VALUE
       Max: Integer.MAX_VALUE
   Default: 0
  Identity: 0
 

Parameters:

yoff - the offset in the y direction, in pixels

getBounds

public BaseBounds getBounds(BaseTransform transform,
                            Effect defaultInput)

Description copied from class: Effect

Returns the bounding box that will be affected by this filter operation when viewed under the specified transform, given its list of input Effects and the specified defaultInput effect. Note that the returned bounds can be smaller or larger than one or more of the inputs.

Overrides:

getBounds in class FilterEffect<RenderState>

Parameters:

transform - the transform the effect will be viewed under

defaultInput - the default input Effect to be used in all cases where a filter has a null input

Returns:

the bounding box of this filter

getResultBounds

public Rectangle getResultBounds(BaseTransform transform,
                                 Rectangle outputClip,
                                 ImageData... inputDatas)

Overrides:

getResultBounds in class Effect

getRenderState

public RenderState getRenderState(FilterContext fctx,
                                  BaseTransform transform,
                                  Rectangle outputClip,
                                  java.lang.Object renderHelper,
                                  Effect defaultInput)

Description copied from class: FilterEffect

Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments. This call can also be used to get a state object for non-rendering cases like querying the bounds of an operation in which case the FilterContext object may be null. outputClip and renderHelper may always be null just as they may be null for a given filter operation.

Specified by:

getRenderState in class FilterEffect<RenderState>

Parameters:

fctx - the context object that would be used by the Renderer if this call is preparing for a render operation, or null

transform - the transform for the output of this operation

outputClip - the clip rectangle that may restrict this operation, or null

renderHelper - the rendering helper object that can be used to shortcut this operation under certain conditions, or null

defaultInput - the Effect to be used in place of any null inputs

Returns:

reducesOpaquePixels

public boolean reducesOpaquePixels()

Description copied from class: Effect

Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input. It is always safe to return true from this method, though the consequences may be that the caller chooses to not utilize a planned optimization.

Specified by:

reducesOpaquePixels in class Effect

Returns:

true if this effect may reduce opacity of some pixels of one of it's input (and thus the default input) or it's relevant input(s) might have reduced opaque pixels of the default input already.

getDirtyRegions

public DirtyRegionContainer getDirtyRegions(Effect defaultInput,
                                            DirtyRegionPool regionPool)

Description copied from class: Effect

Returns the dirty region container containing dirty regions affected by this filter operation.

Overrides:

getDirtyRegions in class Effect

Parameters:

defaultInput - the default input Effect to be used in all cases where a filter has a null input

regionPool - the pool of dirty regions

Returns:

the dirty region container