javafx.scene.effect

Class BoxBlur

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.BoxBlur

public class BoxBlur
extends Effect

A blur effect using a simple box filter kernel, with separately configurable sizes in both dimensions, and an iteration parameter that controls the quality of the resulting blur.

Example:

 BoxBlur boxBlur = new BoxBlur();
 boxBlur.setWidth(10);
 boxBlur.setHeight(3);
 boxBlur.setIterations(3);

 Text text = new Text();
 text.setText("Blurry Text!");
 text.setFill(Color.web("0x3b596d"));
 text.setFont(Font.font(null, FontWeight.BOLD, 50));
 text.setX(10);
 text.setY(50);
 text.setEffect(boxBlur);
 

The code above produces the following:

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
DoubleProperty	height The vertical dimension of the blur effect.
<any>	input The input for this Effect.
IntegerProperty	iterations The number of times to iterate the blur effect to improve its "quality" or "smoothness".
DoubleProperty	width The horizontal dimension of the blur effect.

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Effect

Effect.EffectInputChangeListener, Effect.EffectInputProperty

Field Summary

Fields

Modifier and Type	Field and Description
private DoubleProperty	height The vertical dimension of the blur effect.
private <any>	input The input for this Effect.
private IntegerProperty	iterations The number of times to iterate the blur effect to improve its "quality" or "smoothness".
private DoubleProperty	width The horizontal dimension of the blur effect.

Constructor Summary

Constructors

Constructor and Description
BoxBlur() Creates a new instance of BoxBlur with default parameters.
BoxBlur(double width, double height, int iterations) Creates a new instance of BoxBlur with specified width, height and iterations.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	checkChainContains(Effect e)
(package private) Effect	copy()
(package private) com.sun.scenario.effect.BoxBlur	createPeer()
(package private) BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Returns bounds of given node with applied effect.
private int	getClampedHeight()
private int	getClampedIterations()
private int	getClampedWidth()
double	getHeight() Gets the value of the property height.
Effect	getInput() Gets the value of the property input.
int	getIterations() Gets the value of the property iterations.
double	getWidth() Gets the value of the property width.
DoubleProperty	heightProperty() The vertical dimension of the blur effect.
<any>	inputProperty() The input for this Effect.
IntegerProperty	iterationsProperty() The number of times to iterate the blur effect to improve its "quality" or "smoothness".
void	setHeight(double value) Sets the value of the property height.
void	setInput(Effect value) Sets the value of the property input.
void	setIterations(int value) Sets the value of the property iterations.
void	setWidth(double value) Sets the value of the property width.
(package private) void	update()
DoubleProperty	widthProperty() The horizontal dimension of the blur effect.

Methods inherited from class javafx.scene.effect.Effect

containsCycles, effectBoundsChanged, getInputBounds, getKernelSize, getPeer, getShadowBounds, markDirty, sync, transformBounds

Methods inherited from class java.lang.Object

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

Property Detail

input

public final <any> inputProperty

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

See Also:

getInput(), setInput(Effect)

width

public final DoubleProperty widthProperty

The horizontal dimension of the blur effect. The color information for a given pixel will be spread across a Box of the indicated width centered over the pixel. Values less than or equal to 1 will not spread the color data beyond the pixel where it originated from and so will have no effect.

       Min:   0.0
       Max: 255.0
   Default:   5.0
  Identity:  <1.0
 

See Also:

getWidth(), setWidth(double)

height

public final DoubleProperty heightProperty

The vertical dimension of the blur effect. The color information for a given pixel will be spread across a Box of the indicated height centered over the pixel. Values less than or equal to 1 will not spread the color data beyond the pixel where it originated from and so will have no effect.

       Min:   0.0
       Max: 255.0
   Default:   5.0
  Identity:  <1.0
 

See Also:

getHeight(), setHeight(double)

iterations

public final IntegerProperty iterationsProperty

The number of times to iterate the blur effect to improve its "quality" or "smoothness". Iterating the effect 3 times approximates the quality of a Gaussian Blur to within 3%.

       Min:   0
       Max:   3
   Default:   1
  Identity:   0
 

See Also:

getIterations(), setIterations(int)

Field Detail

input

private <any> input

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

width

private DoubleProperty width

The horizontal dimension of the blur effect. The color information for a given pixel will be spread across a Box of the indicated width centered over the pixel. Values less than or equal to 1 will not spread the color data beyond the pixel where it originated from and so will have no effect.

       Min:   0.0
       Max: 255.0
   Default:   5.0
  Identity:  <1.0
 

height

private DoubleProperty height

The vertical dimension of the blur effect. The color information for a given pixel will be spread across a Box of the indicated height centered over the pixel. Values less than or equal to 1 will not spread the color data beyond the pixel where it originated from and so will have no effect.

       Min:   0.0
       Max: 255.0
   Default:   5.0
  Identity:  <1.0
 

iterations

private IntegerProperty iterations

The number of times to iterate the blur effect to improve its "quality" or "smoothness". Iterating the effect 3 times approximates the quality of a Gaussian Blur to within 3%.

       Min:   0
       Max:   3
   Default:   1
  Identity:   0
 

Constructor Detail

BoxBlur

public BoxBlur()

Creates a new instance of BoxBlur with default parameters.

BoxBlur

public BoxBlur(double width,
               double height,
               int iterations)

Creates a new instance of BoxBlur with specified width, height and iterations.

Parameters:

width - the horizontal dimension of the blur effect

height - the vertical dimension of the blur effect

iterations - the number of times to iterate the blur effect to improve its "quality" or "smoothness"

Method Detail

createPeer

com.sun.scenario.effect.BoxBlur createPeer()

Specified by:

createPeer in class Effect

setInput

public final void setInput(Effect value)

Sets the value of the property input.

getInput

public final Effect getInput()

Gets the value of the property input.

inputProperty

public final <any> inputProperty()

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

See Also:

getInput(), setInput(Effect)

checkChainContains

boolean checkChainContains(Effect e)

Specified by:

checkChainContains in class Effect

setWidth

public final void setWidth(double value)

Sets the value of the property width.

getWidth

public final double getWidth()

Gets the value of the property width.

widthProperty

public final DoubleProperty widthProperty()

The horizontal dimension of the blur effect. The color information for a given pixel will be spread across a Box of the indicated width centered over the pixel. Values less than or equal to 1 will not spread the color data beyond the pixel where it originated from and so will have no effect.

       Min:   0.0
       Max: 255.0
   Default:   5.0
  Identity:  <1.0
 

See Also:

getWidth(), setWidth(double)

setHeight

public final void setHeight(double value)

Sets the value of the property height.

getHeight

public final double getHeight()

Gets the value of the property height.

heightProperty

public final DoubleProperty heightProperty()

The vertical dimension of the blur effect. The color information for a given pixel will be spread across a Box of the indicated height centered over the pixel. Values less than or equal to 1 will not spread the color data beyond the pixel where it originated from and so will have no effect.

       Min:   0.0
       Max: 255.0
   Default:   5.0
  Identity:  <1.0
 

See Also:

getHeight(), setHeight(double)

setIterations

public final void setIterations(int value)

Sets the value of the property iterations.

getIterations

public final int getIterations()

Gets the value of the property iterations.

iterationsProperty

public final IntegerProperty iterationsProperty()

The number of times to iterate the blur effect to improve its "quality" or "smoothness". Iterating the effect 3 times approximates the quality of a Gaussian Blur to within 3%.

       Min:   0
       Max:   3
   Default:   1
  Identity:   0
 

See Also:

getIterations(), setIterations(int)

getClampedWidth

private int getClampedWidth()

getClampedHeight

private int getClampedHeight()

getClampedIterations

private int getClampedIterations()

update

void update()

Specified by:

update in class Effect

getBounds

BaseBounds getBounds(BaseBounds bounds,
                     BaseTransform tx,
                     Node node,
                     BoundsAccessor boundsAccessor)

Description copied from class: Effect

Returns bounds of given node with applied effect. We *never* pass null in as a bounds. This method will NOT take a null bounds object. The returned value may be the same bounds object passed in, or it may be a new object.

Specified by:

getBounds in class Effect

copy

Effect copy()

Specified by:

copy in class Effect