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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	Effect.EffectInputChangeListener
pack-priv class	Effect.EffectInputProperty

Modifier and Type	Field and Description
private IntegerProperty	effectDirty
private Effect	peer

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

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

effectDirty	back to summary
private IntegerProperty effectDirty

peer	back to summary
private Effect peer

Effect	back to summary
protected Effect() Creates a new Effect.

Method Detail

checkChainContains	back to summary
pack-priv abstract boolean checkChainContains(Effect e)

clearEffectDirty	back to summary
private void clearEffectDirty(EffectDirtyBits dirtyBit) Clear the specified dirty bit

containsCycles	back to summary
pack-priv boolean containsCycles(Effect value)

copy	back to summary
pack-priv abstract Effect copy()

createPeer	back to summary
pack-priv abstract Effect createPeer()

effectBoundsChanged	back to summary
pack-priv void effectBoundsChanged()

effectDirtyProperty	back to summary
private final IntegerProperty effectDirtyProperty()

getBounds	back to summary
pack-priv 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.

getInputBounds	back to summary
pack-priv static BaseBounds getInputBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor, Effect input)

getKernelSize	back to summary
pack-priv static int getKernelSize(float fsize, int iterations)

getPeer	back to summary
pack-priv Effect getPeer()

getShadowBounds	back to summary
pack-priv static BaseBounds getShadowBounds(BaseBounds bounds, BaseTransform tx, float width, float height, BlurType blurType)

isEffectDirty	back to summary
private final boolean isEffectDirty()

isEffectDirty	back to summary
private boolean isEffectDirty(EffectDirtyBits dirtyBit) Test the specified dirty bit

markDirty	back to summary
pack-priv final void markDirty(EffectDirtyBits dirtyBit) Set the specified dirty bit

setEffectDirty	back to summary
private void setEffectDirty(int value)

sync	back to summary
pack-priv final void sync()

toggleDirty	back to summary
private void toggleDirty(EffectDirtyBits dirtyBit) Toggle the specified dirty bit

transformBounds	back to summary
pack-priv static BaseBounds transformBounds(BaseTransform tx, BaseBounds r)

update	back to summary
pack-priv abstract void update()

javafx.scene.effect back to summary

pack-priv Class Effect.EffectInputChangeListener

Class Inheritance

extends EffectChangeListener

java.lang.Object
com.sun.javafx.beans.event.AbstractNotifyListener
javafx.scene.effect.EffectChangeListener
javafx.scene.effect.Effect.EffectInputChangeListener

Field Summary

Modifier and Type	Field and Description
private int	oldBits

Inherited from javafx.scene.effect.EffectChangeListener:: registredOn

Constructor Summary

Access	Constructor and Description
pack-priv	EffectInputChangeListener()

Method Summary

Modifier and Type	Method and Description
public void	invalidated(Observable The `Observable` that became invalid valueModel) Implements javafx.beans.InvalidationListener.invalidated. This method needs to be provided by an implementation of `InvalidationListener`.
public void	register(Effect value)

Inherited from javafx.scene.effect.EffectChangeListener:: register

Field Detail

oldBits	back to summary
private int oldBits

Constructor Detail

EffectInputChangeListener	back to summary
pack-priv EffectInputChangeListener()

Method Detail

invalidated back to summary

invalidated	back to summary
public void invalidated(Observable valueModel) Implements javafx.beans.InvalidationListener.invalidated. Doc from javafx.beans.InvalidationListener.invalidated. This method needs to be provided by an implementation of `InvalidationListener`. It is called if an `Observable` becomes invalid. In general, it is considered bad practice to modify the observed value in this method. Parameters valueModel:Observable The `Observable` that became invalid Annotations @Override

public void invalidated(Observable valueModel)

Implements javafx.beans.InvalidationListener.invalidated.

Doc from javafx.beans.InvalidationListener.invalidated.

This method needs to be provided by an implementation of InvalidationListener. It is called if an Observable becomes invalid.

In general, it is considered bad practice to modify the observed value in this method.

Parameters

valueModel:Observable: The Observable that became invalid

Annotations

@Override

register	back to summary
public void register(Effect value)

javafx.scene.effect back to summary

pack-priv Class Effect.EffectInputProperty

Class Inheritance

extends ObjectPropertyBase<Effect>

java.lang.Object
javafx.beans.binding.ObjectExpression
javafx.beans.property.ReadOnlyObjectProperty
javafx.beans.property.ObjectProperty
javafx.beans.property.ObjectPropertyBase
javafx.scene.effect.Effect.EffectInputProperty

Field Summary

Modifier and Type	Field and Description
private final Effect.EffectInputChangeListener	effectChangeListener
private final String	propertyName
private Effect	validInput

Constructor Summary

Access	Constructor and Description
public	EffectInputProperty(final String propertyName)

Method Summary

Modifier and Type	Method and Description
public Object	getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property.
public String	getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property.
public void	invalidated() Overrides javafx.beans.property.ObjectPropertyBase.invalidated. The method `invalidated()` can be overridden to receive invalidation notifications.

Inherited from javafx.beans.property.ObjectPropertyBase:: addListener addListener bind fireValueChangedEvent get isBound removeListener removeListener set toString unbind

Field Detail

effectChangeListener	back to summary
private final Effect.EffectInputChangeListener effectChangeListener

propertyName	back to summary
private final String propertyName

validInput	back to summary
private Effect validInput

Constructor Detail

EffectInputProperty	back to summary
public EffectInputProperty(final String propertyName)

Method Detail

getBean back to summary

getBean	back to summary
public Object getBean() Implements javafx.beans.property.ReadOnlyProperty.getBean. Doc from javafx.beans.property.ReadOnlyProperty.getBean. Returns the `Object` that contains this property. If this property is not contained in an `Object`, `null` is returned. Returns:Object the containing `Object` or `null` Annotations @Override

public Object getBean()

Implements javafx.beans.property.ReadOnlyProperty.getBean.

Doc from javafx.beans.property.ReadOnlyProperty.getBean.

Returns the Object that contains this property. If this property is not contained in an Object, null is returned.

Returns:Object

the containing Object or null

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements javafx.beans.property.ReadOnlyProperty.getName. Doc from javafx.beans.property.ReadOnlyProperty.getName. Returns the name of this property. If the property does not have a name, this method returns an empty `String`. Returns:String the name or an empty `String` Annotations @Override

public String getName()

Implements javafx.beans.property.ReadOnlyProperty.getName.

Doc from javafx.beans.property.ReadOnlyProperty.getName.

Returns the name of this property. If the property does not have a name, this method returns an empty String.

Returns:String

the name or an empty String

Annotations

@Override

invalidated back to summary

invalidated	back to summary
public void invalidated() Overrides javafx.beans.property.ObjectPropertyBase.invalidated. Doc from javafx.beans.property.ObjectPropertyBase.invalidated. The method `invalidated()` can be overridden to receive invalidation notifications. This is the preferred option in `Objects` defining the property, because it requires less memory. The default implementation is empty. Annotations @Override

public void invalidated()

Overrides javafx.beans.property.ObjectPropertyBase.invalidated.

Doc from javafx.beans.property.ObjectPropertyBase.invalidated.

The method invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.

Annotations

@Override

public abstract Class Effect

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Effect.EffectInputChangeListener

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Effect.EffectInputProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail