javafx.scene.effect

Class Bloom

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.Bloom

public class Bloom
extends Effect

A high-level effect that makes brighter portions of the input image appear to glow, based on a configurable threshold.

Example:

 Bloom bloom = new Bloom();
 bloom.setThreshold(0.1);

 Rectangle rect = new Rectangle();
 rect.setX(10);
 rect.setY(10);
 rect.setWidth(160);
 rect.setHeight(80);
 rect.setFill(Color.DARKSLATEBLUE);

 Text text = new Text();
 text.setText("Bloom!");
 text.setFill(Color.ALICEBLUE);
 text.setFont(Font.font(null, FontWeight.BOLD, 40));
 text.setX(25);
 text.setY(65);
 text.setEffect(bloom);
 

The code above produces the following:

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
<any>	input The input for this Effect.
DoubleProperty	threshold The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

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	threshold The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
(package private) boolean	checkChainContains(Effect e)
(package private) Effect	copy()
(package private) com.sun.scenario.effect.Bloom	createPeer()
(package private) BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Returns bounds of given node with applied effect.
Effect	getInput() Gets the value of the property input.
double	getThreshold() Gets the value of the property threshold.
<any>	inputProperty() The input for this Effect.
void	setInput(Effect value) Sets the value of the property input.
void	setThreshold(double value) Sets the value of the property threshold.
DoubleProperty	thresholdProperty() The threshold value controls the minimum luminosity value of the pixels that will be made to glow.
(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)

threshold

public final DoubleProperty thresholdProperty

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

See Also:

getThreshold(), setThreshold(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.

threshold

private DoubleProperty threshold

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

Constructor Detail

Bloom

public Bloom()

Creates a new instance of Bloom with default parameters.

Bloom

public Bloom(double threshold)

Creates a new instance of Bloom with the specified threshold.

Parameters:

threshold - the threshold value for the bloom effect

Since:

JavaFX 2.1

Method Detail

createPeer

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

setThreshold

public final void setThreshold(double value)

Sets the value of the property threshold.

getThreshold

public final double getThreshold()

Gets the value of the property threshold.

thresholdProperty

public final DoubleProperty thresholdProperty()

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

See Also:

getThreshold(), setThreshold(double)

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