org.girod.javafx.svgimage.xml.specs

Class FilterSpec.FEComposite

java.lang.Object

org.girod.javafx.svgimage.xml.specs.FilterSpec.AbstractFilterEffect

org.girod.javafx.svgimage.xml.specs.FilterSpec.FEComposite

All Implemented Interfaces:

FilterSpec.FilterEffect

Enclosing class:

FilterSpec

public static class FilterSpec.FEComposite
extends FilterSpec.AbstractFilterEffect

Filter effect for compositing two inputs.

Field Summary

Fields

Modifier and Type	Field and Description
static short	OPERATOR_ARITHMETIC Composite operator: arithmetic.
static short	OPERATOR_ATOP Composite operator: atop.
static short	OPERATOR_IN Composite operator: in.
static short	OPERATOR_OUT Composite operator: out.
static short	OPERATOR_OVER Composite operator: over.
static short	OPERATOR_XOR Composite operator: xor.

Fields inherited from class org.girod.javafx.svgimage.xml.specs.FilterSpec.AbstractFilterEffect

in, inputType, resultId

Constructor Summary

Constructors

Constructor and Description
FEComposite(String resultId, short type, String in, String in2) Create a composite effect.

Method Summary

Modifier and Type	Method and Description
javafx.scene.effect.Effect	getEffect(javafx.scene.Node node) Return the associated JavaFX effect.
boolean	isSecondLast() Return true if the composite takes the source graphic as the first input.
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.
boolean	shouldApply(List<FilterSpec.AppliedEffect> appliedEffects, int index) Return true if the composite should apply at the given index.

Methods inherited from class org.girod.javafx.svgimage.xml.specs.FilterSpec.AbstractFilterEffect

getInputType, getResultId, setIn

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR_OVER

public static final short OPERATOR_OVER

Composite operator: over.

See Also:

Constant Field Values

OPERATOR_IN

public static final short OPERATOR_IN

Composite operator: in.

See Also:

Constant Field Values

OPERATOR_OUT

public static final short OPERATOR_OUT

Composite operator: out.

See Also:

Constant Field Values

OPERATOR_ATOP

public static final short OPERATOR_ATOP

Composite operator: atop.

See Also:

Constant Field Values

OPERATOR_XOR

public static final short OPERATOR_XOR

Composite operator: xor.

See Also:

Constant Field Values

OPERATOR_ARITHMETIC

public static final short OPERATOR_ARITHMETIC

Composite operator: arithmetic.

See Also:

Constant Field Values

Constructor Detail

FEComposite

public FEComposite(String resultId,
                   short type,
                   String in,
                   String in2)

Create a composite effect.

Parameters:

resultId - the result id

type - the composite operator

in - the first input reference

in2 - the second input reference

Method Detail

shouldApply

public boolean shouldApply(List<FilterSpec.AppliedEffect> appliedEffects,
                           int index)

Return true if the composite should apply at the given index.

Parameters:

appliedEffects - the applied effects list

index - the current index

Returns:

true if the composite should apply

isSecondLast

public boolean isSecondLast()

Return true if the composite takes the source graphic as the first input.

Returns:

true if the first input is the source graphic

getEffect

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

Description copied from interface: FilterSpec.FilterEffect

Return the associated JavaFX effect.

Parameters:

node - the node on which the effect applies

Returns:

the effect

resolveEffect

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

Description copied from interface: FilterSpec.FilterEffect

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