com.sun.scenario.effect

Class Flood

java.lang.Object

com.sun.scenario.effect.Effect

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

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

com.sun.scenario.effect.Flood

public class Flood
extends CoreEffect<RenderState>

An effect that renders a rectangular region that is filled ("flooded") with the given paint. This is equivalent to rendering a filled rectangle into an image and using an Identity effect, except that it is more convenient and potentially much more efficient.

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 RectBounds	bounds
private java.lang.Object	paint

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
Flood(java.lang.Object paint) Constructs a new Flood effect using the given platform-specific paint object with an empty bounds for the flood region.
Flood(java.lang.Object paint, RectBounds bounds) Constructs a new Flood effect using the given platform-specific paint object to cover the indicated rectangular bounds.

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.
RectBounds	getFloodBounds()
java.lang.Object	getPaint() Returns the platform-specific paint object used to flood the region.
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.
boolean	reducesOpaquePixels() Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.
void	setFloodBounds(RectBounds bounds)
void	setPaint(java.lang.Object paint) Sets the platform-specific paint object used to flood the region.
Point2D	transform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output.
Point2D	untransform(Point2D p, Effect defaultInput) Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input.

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

filterImageDatas, getAccelType, getPeer, updatePeerKey, updatePeerKey

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

filter, untransformClip

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

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

Methods inherited from class java.lang.Object

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

Field Detail

paint

private java.lang.Object paint

bounds

private RectBounds bounds

Constructor Detail

Flood

public Flood(java.lang.Object paint)

Constructs a new Flood effect using the given platform-specific paint object with an empty bounds for the flood region.

Parameters:

paint - the platform-specific paint object used to flood the region

Throws:

java.lang.IllegalArgumentException - if paint is null

Flood

public Flood(java.lang.Object paint,
             RectBounds bounds)

Constructs a new Flood effect using the given platform-specific paint object to cover the indicated rectangular bounds.

Parameters:

paint - the platform-specific paint object used to flood the region

bounds - the rectangular area to cover

Throws:

java.lang.IllegalArgumentException - if either paint or bounds is null

Method Detail

getPaint

public java.lang.Object getPaint()

Returns the platform-specific paint object used to flood the region.

Returns:

the flood paint

setPaint

public void setPaint(java.lang.Object paint)

Sets the platform-specific paint object used to flood the region.

Parameters:

paint - the flood paint

Throws:

java.lang.IllegalArgumentException - if paint is null

getFloodBounds

public RectBounds getFloodBounds()

setFloodBounds

public void setFloodBounds(RectBounds bounds)

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

transform

public Point2D transform(Point2D p,
                         Effect defaultInput)

Transform the specified point p from the coordinate space of the primary content input to the coordinate space of the effect output. In essence, this method asks the question "Which output coordinate is most affected by the data at the specified coordinate in the primary source input?"

Since no source input is used, any output coordinate is equally affected, or unaffected, by any source coordinate so an undefined point (NaN, NaN) is returned.

Overrides:

transform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the primary content input to be transformed

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

Returns:

the undefined point (NaN, NaN)

untransform

public Point2D untransform(Point2D p,
                           Effect defaultInput)

Transform the specified point p from the coordinate space of the output of the effect into the coordinate space of the primary content input. In essence, this method asks the question "Which source coordinate contributes most to the definition of the output at the specified coordinate?"

Since the Flood effect does not use any source data it returns an undefined coordinate (NaN, NaN) for all requests.

Overrides:

untransform in class FilterEffect<RenderState>

Parameters:

p - the point in the coordinate space of the result output to be transformed

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

Returns:

the undefined point (NaN, NaN)

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