javafx.scene.effect

Class GaussianBlur

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.GaussianBlur

public class GaussianBlur
extends Effect

A blur effect using a Gaussian convolution kernel, with a configurable radius.

Example:

 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(new GaussianBlur());
 

The code above produces the following:

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
<any>	input The input for this Effect.
DoubleProperty	radius The radius of the blur kernel.

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 <any>	input The input for this Effect.
private DoubleProperty	radius The radius of the blur kernel.

Constructor Summary

Constructors

Constructor and Description
GaussianBlur() Creates a new instance of GaussianBlur with default parameters.
GaussianBlur(double radius) Creates a new instance of GaussianBlur with the specified radius.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	checkChainContains(Effect e)
(package private) Effect	copy()
(package private) com.sun.scenario.effect.GaussianBlur	createPeer()
(package private) BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Returns bounds of given node with applied effect.
private float	getClampedRadius()
Effect	getInput() Gets the value of the property input.
double	getRadius() Gets the value of the property radius.
<any>	inputProperty() The input for this Effect.
DoubleProperty	radiusProperty() The radius of the blur kernel.
void	setInput(Effect value) Sets the value of the property input.
void	setRadius(double value) Sets the value of the property radius.
(package private) void	update()

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)

radius

public final DoubleProperty radiusProperty

The radius of the blur kernel.

       Min:  0.0
       Max: 63.0
   Default: 10.0
  Identity:  0.0
 

See Also:

getRadius(), setRadius(double)

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.

radius

private DoubleProperty radius

The radius of the blur kernel.

       Min:  0.0
       Max: 63.0
   Default: 10.0
  Identity:  0.0
 

Constructor Detail

GaussianBlur

public GaussianBlur()

Creates a new instance of GaussianBlur with default parameters.

GaussianBlur

public GaussianBlur(double radius)

Creates a new instance of GaussianBlur with the specified radius.

Parameters:

radius - the radius of the blur kernel

Since:

JavaFX 2.1

Method Detail

createPeer

com.sun.scenario.effect.GaussianBlur 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

setRadius

public final void setRadius(double value)

Sets the value of the property radius.

getRadius

public final double getRadius()

Gets the value of the property radius.

radiusProperty

public final DoubleProperty radiusProperty()

The radius of the blur kernel.

       Min:  0.0
       Max: 63.0
   Default: 10.0
  Identity:  0.0
 

See Also:

getRadius(), setRadius(double)

getClampedRadius

private float getClampedRadius()

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