public class Crop extends CoreEffect<RenderState>
Effect.AccelType
DefaultInput
Constructor and Description |
---|
Crop(Effect source)
Constructs a new
Crop effect which crops the output of
the specified source Effect to the bounds of the default
input. |
Crop(Effect source,
Effect boundsInput)
Constructs a new
Crop effect to crop the output of the
specified source Effect to the bounds of the specified
bounds Effect . |
Modifier and Type | Method and Description |
---|---|
ImageData |
filter(FilterContext fctx,
BaseTransform transform,
Rectangle outputClip,
java.lang.Object renderHelper,
Effect defaultInput)
Applies this filter effect to the series of images represented by
the input
Effect s and/or the given defaultInput
viewed under the given transform . |
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 Effect s and the specified
defaultInput effect. |
Effect |
getBoundsInput()
Returns the bounds input for this
Effect . |
private Effect |
getBoundsInput(Effect defaultInput) |
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 . |
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 |
setBoundsInput(Effect input)
Sets the bounds input for this
Effect . |
void |
setInput(Effect input)
Sets the source input for this
Effect to a specific
Effect or to the default input if input is
null . |
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. |
filterImageDatas, getAccelType, getPeer, updatePeerKey, updatePeerKey
untransformClip
combineBounds, combineBounds, createCompatibleImage, ensureTransform, getCompatibleImage, getDefaultedInput, getDefaultedInput, getInputs, getNumInputs, getResultBounds, getState, releaseCompatibleImage, setInput, transformBounds
public Crop(Effect source)
Crop
effect which crops the output of
the specified source Effect
to the bounds of the default
input.source
- the input Effect
for image datapublic final Effect getInput()
Effect
.Effect
public void setInput(Effect input)
Effect
to a specific
Effect
or to the default input if input
is
null
.input
- the input for this Effect
public final Effect getBoundsInput()
Effect
.Effect
public void setBoundsInput(Effect input)
Effect
.
Sets the bounds input for this Effect
to a specific
Effect
or to the default input if input
is
null
.input
- the bounds input for this Effect
public BaseBounds getBounds(BaseTransform transform, Effect defaultInput)
Effect
transform
,
given its list of input Effect
s and the specified
defaultInput
effect.
Note that the returned bounds can be smaller or larger than one
or more of the inputs.getBounds
in class FilterEffect<RenderState>
transform
- the transform the effect will be viewed underdefaultInput
- the default input Effect
to be used in
all cases where a filter has a null inputpublic Point2D transform(Point2D p, Effect defaultInput)
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?"
The Crop
effect delegates this operation to its primary
(non-bounds) input, or the defaultInput
if the primary
input is null
.
transform
in class FilterEffect<RenderState>
p
- the point in the coordinate space of the primary content
input to be transformeddefaultInput
- the default input Effect
to be used in
all cases where a filter has a null inputpublic Point2D untransform(Point2D p, Effect defaultInput)
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?"
The Crop
effect delegates this operation to its primary
(non-bounds) input, or the defaultInput
if the primary
input is null
.
untransform
in class FilterEffect<RenderState>
p
- the point in the coordinate space of the result output
to be transformeddefaultInput
- the default input Effect
to be used in
all cases where a filter has a null inputpublic ImageData filter(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput)
Effect
Effect
s and/or the given defaultInput
viewed under the given transform
.
The filter does not need to create pixel data for any pixels that
fall outside of the destination device-space (pixel) bounds specified
by the outputClip
Rectangle
.
The filter might be able to use the renderHelper
object to
render the results directly on its own if the object is not null and
implements an interface, such as ImageHelper
, that the filter
recognizes.
If the effect renders itself then it will return a null
for
the ImageData
result.
Note that the ImageData
object returned by this method must be
validated prior to use with
ImageData.validate(com.sun.scenario.effect.FilterContext)
method.
boolean valid; do { ImageData res = filter(fctx, transform, clip, renderer, defaultInput); if (res == null) { break; } if (valid = res.validate(fctx)) { // Render res.getImage() to the appropriate destination // or use it as an input to another chain of effects. } res.unref(); } while (!valid);
filter
in class FilterEffect<RenderState>
fctx
- the FilterContext
that determines the
environment (e.g. the graphics device or code path) on which
the filter operation will be performedtransform
- an optional transform under which the filter and
its inputs will be viewedoutputClip
- the device space (pixel) bounds of the output
image or window or clip into which the result of the Effect will
be rendered, or null if the output dimensions are not known.renderHelper
- an object which might be used to render
the results of the effect directly.defaultInput
- the default input Effect
to be used in
all cases where a filter has a null input.ImageData
holding the result of this filter
operation or null
if the filter had no output or used the
renderHelper
to render its results directly.public RenderState getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, java.lang.Object renderHelper, Effect defaultInput)
FilterEffect
FilterContext
object may be null.
outputClip
and renderHelper
may always be null just
as they may be null for a given filter operation.getRenderState
in class FilterEffect<RenderState>
fctx
- the context object that would be used by the Renderer
if this call is preparing for a render operation, or nulltransform
- the transform for the output of this operationoutputClip
- the clip rectangle that may restrict this operation, or nullrenderHelper
- the rendering helper object that can be used to shortcut
this operation under certain conditions, or nulldefaultInput
- the Effect
to be used in place of any null inputspublic boolean reducesOpaquePixels()
Effect
reducesOpaquePixels
in class Effect
public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool)
Effect
getDirtyRegions
in class Effect
defaultInput
- the default input Effect
to be used in
all cases where a filter has a null inputregionPool
- the pool of dirty regions