Top Description Fields Constructors Methods
com.sun.scenario.effect

public Class ZoomRadialBlur

extends CoreEffect<RenderState>
Class Inheritance
Imports
com.sun.scenario.effect.impl.state.ZoomRadialBlurState, .RenderState, com.sun.javafx.geom.DirtyRegionContainer, .DirtyRegionPool, .Rectangle, com.sun.javafx.geom.transform.BaseTransform

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

Field Summary

Modifier and TypeField and Description
private float
private float
private int
r

private final ZoomRadialBlurState

Constructor Summary

AccessConstructor and Description
public
ZoomRadialBlur()

Constructs a new ZoomRadialBlur effect with the default radius (1), using the default input for source data.

public
ZoomRadialBlur(int
the radius of the kernel
radius
)

Constructs a new ZoomRadialBlur effect with the given radius, using the default input for source data.

public
ZoomRadialBlur(int
of ZoomRadialBlur
radius
,
Effect
the single input Effect
input
)

Constructs a new ZoomRadialBlur effect with the given radius.

Method Summary

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

Overrides com.sun.scenario.effect.CoreEffect.filterImageDatas.

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

public float

Returns:

the X coordinate of the center point
getCenterX
()

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

public float

Returns:

the Y coordinate of the center point
getCenterY
()

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

public DirtyRegionContainer
getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool)

Overrides com.sun.scenario.effect.Effect.getDirtyRegions.

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

public final Effect

Returns:

the input for this Effect
getInput
()

Returns the input for this Effect.

public int

Returns:

the radius of the effect kernel
getRadius
()

Returns the radius of the effect kernel.

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

Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState.

Returns the object representing the rendering strategy and state for the filter operation characterized by the specified arguments.

pack-priv Object
getState()

Overrides com.sun.scenario.effect.Effect.getState.

Returns state object that is associated with this effect instance.

public boolean
reducesOpaquePixels()

Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels.

Whether an opacity for any pixel is different (lower) than the corresponding pixel in the default input.

public void
setCenterX(float
the X coordinate of the center point
centerX
)

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

public void
setCenterY(float
the Y coordinate of the center point
centerY
)

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

public void
setInput(Effect
the input for this Effect
input
)

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

public void
setRadius(int
the radius of the effect kernel
radius
)

Sets the radius of the effect kernel.

private void
updatePeer()

Updates the peer "key" for the current radius.

Inherited from com.sun.scenario.effect.CoreEffect:
getAccelTypegetPeerupdatePeerKeyupdatePeerKey

Field Detail

centerXback to summary
private float centerX
centerYback to summary
private float centerY
rback to summary
private int r
stateback to summary
private final ZoomRadialBlurState state

Constructor Detail

ZoomRadialBlurback to summary
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)
ZoomRadialBlurback to summary
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:int

the radius of the kernel

Exceptions
IllegalArgumentException:
if radius is outside the allowable range
ZoomRadialBlurback to summary
public ZoomRadialBlur(int radius, Effect input)

Constructs a new ZoomRadialBlur effect with the given radius.

Parameters
radius:int

of ZoomRadialBlur

input:Effect

the single input Effect

Exceptions
IllegalArgumentException:
if radius is outside the allowable range

Method Detail

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

Overrides com.sun.scenario.effect.CoreEffect.filterImageDatas.

Doc from com.sun.scenario.effect.CoreEffect.filterImageDatas.

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

Annotations
@Override
getCenterXback to summary
public float getCenterX()

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

Returns:float

the X coordinate of the center point

getCenterYback to summary
public float getCenterY()

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

Returns:float

the Y coordinate of the center point

getDirtyRegionsback to summary
public DirtyRegionContainer getDirtyRegions(Effect defaultInput, DirtyRegionPool regionPool)

Overrides com.sun.scenario.effect.Effect.getDirtyRegions.

Doc from com.sun.scenario.effect.Effect.getDirtyRegions.

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

Annotations
@Override
getInputback to summary
public final Effect getInput()

Returns the input for this Effect.

Returns:Effect

the input for this Effect

getRadiusback to summary
public int getRadius()

Returns the radius of the effect kernel.

Returns:int

the radius of the effect kernel

getRenderStateback to summary
public RenderState getRenderState(FilterContext fctx, BaseTransform transform, Rectangle outputClip, Object renderHelper, Effect defaultInput)

Implements abstract com.sun.scenario.effect.FilterEffect.getRenderState.

Doc from com.sun.scenario.effect.FilterEffect.getRenderState.

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.

Annotations
@Override
getStateback to summary
pack-priv Object getState()

Overrides com.sun.scenario.effect.Effect.getState.

Doc from com.sun.scenario.effect.Effect.getState.

Returns state object that is associated with this effect instance. Subclasses may override this method to return some sort of state object that contains implementation details that are hidden from the public API. Classes outside this package can use the AccessHelper class to get access to this package-private method.

Annotations
@Override
reducesOpaquePixelsback to summary
public boolean reducesOpaquePixels()

Implements abstract com.sun.scenario.effect.Effect.reducesOpaquePixels.

Doc from com.sun.scenario.effect.Effect.reducesOpaquePixels.

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.

Annotations
@Override
setCenterXback to summary
public void setCenterX(float centerX)

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

Parameters
centerX:float

the X coordinate of the center point

setCenterYback to summary
public void setCenterY(float centerY)

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

Parameters
centerY:float

the Y coordinate of the center point

setInputback to summary
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:Effect

the input for this Effect

setRadiusback to summary
public void setRadius(int radius)

Sets the radius of the effect kernel.

      Min:   1
      Max:  64
  Default:   1
 Identity: n/a
Parameters
radius:int

the radius of the effect kernel

Exceptions
IllegalArgumentException:
if radius is outside the allowable range
updatePeerback to summary
private void updatePeer()

Updates the peer "key" for the current radius.