javafx.scene.effect

Class Effect

java.lang.Object

javafx.scene.effect.Effect

Direct Known Subclasses:

Blend, Bloom, BoxBlur, ColorAdjust, ColorInput, DisplacementMap, DropShadow, GaussianBlur, Glow, ImageInput, InnerShadow, Lighting, MotionBlur, PerspectiveTransform, Reflection, SepiaTone, Shadow

public abstract class Effect
extends java.lang.Object

The abstract base class for all effect implementations. An effect is a graphical algorithm that produces an image, typically as a modification of a source image. An effect can be associated with a scene graph Node by setting the Node.effect attribute. Some effects change the color properties of the source pixels (such as ColorAdjust), others combine multiple images together (such as Blend), while still others warp or move the pixels of the source image around (such as DisplacementMap or PerspectiveTransform). All effects have at least one input defined and the input can be set to another effect to chain the effects together and combine their results, or it can be left unspecified in which case the effect will operate on a graphical rendering of the node it is attached to.

Note: this is a conditional feature. See ConditionalFeature.EFFECT for more information.

Since:

JavaFX 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Effect.EffectInputChangeListener
(package private) class	Effect.EffectInputProperty

Field Summary

Fields

Modifier and Type	Field and Description
private IntegerProperty	effectDirty
private com.sun.scenario.effect.Effect	peer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Effect() Creates a new Effect.

Method Summary

Modifier and Type	Method and Description
(package private) abstract boolean	checkChainContains(Effect e)
private void	clearEffectDirty(EffectDirtyBits dirtyBit) Clear the specified dirty bit
(package private) boolean	containsCycles(Effect value)
(package private) abstract Effect	copy()
(package private) abstract com.sun.scenario.effect.Effect	createPeer()
(package private) void	effectBoundsChanged()
private IntegerProperty	effectDirtyProperty()
(package private) abstract BaseBounds	getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) Returns bounds of given node with applied effect.
(package private) static BaseBounds	getInputBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor, Effect input)
(package private) static int	getKernelSize(float fsize, int iterations)
(package private) com.sun.scenario.effect.Effect	getPeer()
(package private) static BaseBounds	getShadowBounds(BaseBounds bounds, BaseTransform tx, float width, float height, BlurType blurType)
private boolean	isEffectDirty()
private boolean	isEffectDirty(EffectDirtyBits dirtyBit) Test the specified dirty bit
(package private) void	markDirty(EffectDirtyBits dirtyBit) Set the specified dirty bit
private void	setEffectDirty(int value)
(package private) void	sync()
private void	toggleDirty(EffectDirtyBits dirtyBit) Toggle the specified dirty bit
(package private) static BaseBounds	transformBounds(BaseTransform tx, BaseBounds r)
(package private) abstract void	update()

Methods inherited from class java.lang.Object

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

Field Detail

peer

private com.sun.scenario.effect.Effect peer

effectDirty

private IntegerProperty effectDirty

Constructor Detail

Effect

protected Effect()

Creates a new Effect.

Method Detail

effectBoundsChanged

void effectBoundsChanged()

createPeer

abstract com.sun.scenario.effect.Effect createPeer()

getPeer

com.sun.scenario.effect.Effect getPeer()

setEffectDirty

private void setEffectDirty(int value)

effectDirtyProperty

private final IntegerProperty effectDirtyProperty()

isEffectDirty

private final boolean isEffectDirty()

markDirty

final void markDirty(EffectDirtyBits dirtyBit)

Set the specified dirty bit

toggleDirty

private void toggleDirty(EffectDirtyBits dirtyBit)

Toggle the specified dirty bit

isEffectDirty

private boolean isEffectDirty(EffectDirtyBits dirtyBit)

Test the specified dirty bit

clearEffectDirty

private void clearEffectDirty(EffectDirtyBits dirtyBit)

Clear the specified dirty bit

sync

final void sync()

update

abstract void update()

checkChainContains

abstract boolean checkChainContains(Effect e)

containsCycles

boolean containsCycles(Effect value)

getBounds

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

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.

copy

abstract Effect copy()

transformBounds

static BaseBounds transformBounds(BaseTransform tx,
                                  BaseBounds r)

getKernelSize

static int getKernelSize(float fsize,
                         int iterations)

getShadowBounds

static BaseBounds getShadowBounds(BaseBounds bounds,
                                  BaseTransform tx,
                                  float width,
                                  float height,
                                  BlurType blurType)

getInputBounds

static BaseBounds getInputBounds(BaseBounds bounds,
                                 BaseTransform tx,
                                 Node node,
                                 BoundsAccessor boundsAccessor,
                                 Effect input)