BoxBlur (Java FX 2.0)

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 contols the quality of the resulting blur.

import javafx.scene.*;
import javafx.scene.text.*;
import javafx.scene.paint.*;
import javafx.scene.effect.*;

Text t = new Text();
t.setText("Blurry Text!");
t.setFill(Color.RED);
t.setFont(Font.font(null, FontWeight.BOLD, 36));
t.setX(10);
t.setY(40);

BoxBlur bb = new BoxBlur();
bb.setWidth(15);
bb.setHeight(15);
bb.setIterations(3);

t.setEffect(bb);

Property Summary

Properties
Type	Property and Description
`DoubleProperty`	`height` The vertical dimension of the blur effect.
`ObjectProperty<Effect>`	`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.

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

Methods
Modifier and Type	Method and Description
`double`	`getHeight()` The vertical dimension of the blur effect.
`Effect`	`getInput()` The input for this `Effect`.
`int`	`getIterations()` The number of times to iterate the blur effect to improve its "quality" or "smoothness".
`double`	`getWidth()` The horizontal dimension of the blur effect.
`DoubleProperty`	`heightProperty()` The vertical dimension of the blur effect.
`ObjectProperty<Effect>`	`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)` The vertical dimension of the blur effect.
`void`	`setInput(Effect value)` The input for this `Effect`.
`void`	`setIterations(int value)` The number of times to iterate the blur effect to improve its "quality" or "smoothness".
`void`	`setWidth(double value)` The horizontal dimension of the blur effect.
`DoubleProperty`	`widthProperty()` The horizontal dimension of the blur effect.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - 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.
    
    See Also:
    getInput(), setInput(Effect)
  - 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
 
```
    See Also:
    getWidth(), setWidth(double)
  - 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
 
```
    See Also:
    getHeight(), setHeight(double)
  - 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
 
```
    See Also:
    getIterations(), setIterations(int)
- 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
  - setInput
```
public final void setInput(Effect value)
```
    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.
  - getInput
```
public final Effect getInput()
```
    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.
  - inputProperty
```
public final ObjectProperty<Effect> 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)
  - setWidth
```
public final void setWidth(double value)
```
    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
 
```
  - getWidth
```
public final double getWidth()
```
    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
 
```
  - 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)
```
    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
 
```
  - getHeight
```
public final double getHeight()
```
    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
 
```
  - 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)
```
    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
 
```
  - getIterations
```
public final int getIterations()
```
    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
 
```
  - 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)

Class BoxBlur

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

input

width

height

iterations

Constructor Detail

BoxBlur

BoxBlur

Method Detail

setInput

getInput

inputProperty

setWidth

getWidth

widthProperty

setHeight

getHeight

heightProperty

setIterations

getIterations

iterationsProperty