org.girod.javafx.svgimage.xml.specs

Interface FilterSpec.FilterEffect

All Known Implementing Classes:

FilterSpec.AbstractFilterEffect, FilterSpec.FEComposite, FilterSpec.FEDiffuseLighting, FilterSpec.FEDropShadow, FilterSpec.FEFlood, FilterSpec.FEGaussianBlur, FilterSpec.FEImage, FilterSpec.FEMerge, FilterSpec.FEOffset, FilterSpec.FESpecularLighting

Enclosing class:

FilterSpec

public static interface FilterSpec.FilterEffect

Defines a filter effect specification that can produce a JavaFX effect.

Method Summary

Modifier and Type	Method and Description
javafx.scene.effect.Effect	getEffect(javafx.scene.Node node) Return the associated JavaFX effect.
short	getInputType() Return the input type for this effect.
String	getResultId() Return the filter result Id.
default void	resolveEffect(javafx.scene.effect.Effect effect, javafx.scene.effect.Effect sourceAlpha, javafx.scene.effect.Effect previousEffect, Map<String,javafx.scene.effect.Effect> namedEffects) Resolve the effect inputs once all effects are created.
void	setIn(String in) Set the input reference for the effect.

Method Detail

getResultId

String getResultId()

Return the filter result Id.

Returns:

the result Id

getInputType

short getInputType()

Return the input type for this effect.

Returns:

the input type

setIn

void setIn(String in)

Set the input reference for the effect.

Parameters:

in - the input id or keyword

getEffect

javafx.scene.effect.Effect getEffect(javafx.scene.Node node)

Return the associated JavaFX effect.

Parameters:

node - the node on which the effect applies

Returns:

the effect

resolveEffect

default void resolveEffect(javafx.scene.effect.Effect effect,
                           javafx.scene.effect.Effect sourceAlpha,
                           javafx.scene.effect.Effect previousEffect,
                           Map<String,javafx.scene.effect.Effect> namedEffects)

Resolve the effect inputs once all effects are created.

Parameters:

effect - the JavaFX effect instance

sourceAlpha - the source alpha effect

previousEffect - the previous effect in the chain

namedEffects - the map of named effects by id