com.sun.scenario.effect

Class ZoomRadialBlur

java.lang.Object

com.sun.scenario.effect.Effect

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

com.sun.scenario.effect.ZoomRadialBlur

public class ZoomRadialBlur
extends FilterEffect<T>

Zoom radial blur effect with a configurable center and radius of the kernel.

Nested Class Summary

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

Effect.AccelType

Field Summary

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

DefaultInput

Constructor Summary

Constructors

Constructor and Description
ZoomRadialBlur() Constructs a new ZoomRadialBlur effect with the default radius (1), using the default input for source data.
ZoomRadialBlur(int radius) Constructs a new ZoomRadialBlur effect with the given radius, using the default input for source data.
ZoomRadialBlur(int radius, Effect input) Constructs a new ZoomRadialBlur effect with the given radius.

Method Summary

Modifier and Type	Method and Description
ImageData	filterImageDatas(FilterContext fctx, BaseTransform transform, Rectangle outputClip, RenderState rstate, ImageData... inputs) Convenience method that sends the given input data through the current peer, and then attempts to release the input image data.
Effect.AccelType	getAccelType(FilterContext fctx) Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.
float	getCenterX() Returns the X coordinate of the center point of this effect.
float	getCenterY() Returns the Y coordinate of the center point of this 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	getRadius() Returns the radius of the effect kernel.
RenderState	getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, 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	setCenterX(float centerX) Sets the X coordinate of the center point of this effect.
void	setCenterY(float centerY) Sets the Y coordinate of the center point of this effect.
void	setInput(Effect input) Sets the input for this Effect to a specific Effect or to the default input if input is null.
void	setRadius(int radius) Sets the radius of the effect kernel.

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

filter, getBounds, transform, untransform, untransformClip

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoomRadialBlur

public ZoomRadialBlur()

Constructs a new ZoomRadialBlur effect with the default radius (1), using the default input for source data. This is a shorthand equivalent to:

     new ZoomRadialBlur(1, DefaultInput)
 

ZoomRadialBlur

public ZoomRadialBlur(int radius)

Constructs a new ZoomRadialBlur effect with the given radius, using the default input for source data. This is a shorthand equivalent to:

     new ZoomRadialBlur(radius, DefaultInput)
 

Parameters:

radius - the radius of the kernel

Throws:

IllegalArgumentException - if radius is outside the allowable range

ZoomRadialBlur

public ZoomRadialBlur(int radius,
                      Effect input)

Constructs a new ZoomRadialBlur effect with the given radius.

Parameters:

radius - of ZoomRadialBlur

input - the single input Effect

Throws:

IllegalArgumentException - if radius is outside the allowable range

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

getRadius

public int getRadius()

Returns the radius of the effect kernel.

Returns:

the radius of the effect kernel

setRadius

public void setRadius(int radius)

Sets the radius of the effect kernel.

       Min:   1
       Max:  64
   Default:   1
  Identity: n/a
 

Parameters:

radius - the radius of the effect kernel

Throws:

IllegalArgumentException - if radius is outside the allowable range

getCenterX

public float getCenterX()

Returns the X coordinate of the center point of this effect.

Returns:

the X coordinate of the center point

setCenterX

public void setCenterX(float centerX)

Sets the X coordinate of the center point of this effect.

Parameters:

centerX - the X coordinate of the center point

getCenterY

public float getCenterY()

Returns the Y coordinate of the center point of this effect.

Returns:

the Y coordinate of the center point

setCenterY

public void setCenterY(float centerY)

Sets the Y coordinate of the center point of this effect.

Parameters:

centerY - the Y coordinate of the center point

filterImageDatas

public ImageData filterImageDatas(FilterContext fctx,
                                  BaseTransform transform,
                                  Rectangle outputClip,
                                  RenderState rstate,
                                  ImageData... inputs)

Convenience method that sends the given input data through the current peer, and then attempts to release the input image data.

getRenderState

public RenderState getRenderState(FilterContext fctx,
                                  BaseTransform transform,
                                  Rectangle outputClip,
                                  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

getAccelType

public Effect.AccelType getAccelType(FilterContext fctx)

Description copied from class: Effect

Returns one of the AccelType values, indicating whether this Effect is accelerated in hardware for the given FilterContext.

Specified by:

getAccelType in class Effect

Returns:

one of the AccelType values