javafx.scene.effect

Class Blend

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.Blend

public class Blend
extends Effect

An effect that blends the two inputs together using one of the pre-defined BlendModes.

import javafx.scene.*;
import javafx.scene.effect.*;
import javafx.scene.paint.*;
import javafx.scene.shape.*;
import javafx.scene.text.*;

Blend blend = new Blend();
blend.setMode(BlendMode.MULTIPLY);

ColorInput colorInput = new ColorInput();
colorInput.setPaint(Color.BLUE);
colorInput.setX(10);
colorInput.setY(10);
colorInput.setWidth(160);
colorInput.setHeight(80);

blend.setTopInput(colorInput);

Rectangle r = new Rectangle();
r.setWidth(180);
r.setHeight(100);
Stop[] stops = new Stop[] {new Stop(0, Color.RED), new Stop(1, Color.YELLOW)};
LinearGradient lg = new LinearGradient(0, 0, 0.25, 0.25, true, CycleMethod.REFLECT, stops);
r.setFill(lg);

Text t = new Text();
t.setEffect(blend);
t.setX(25);
t.setY(65);
t.setFill(Color.RED);
t.setText("SrcOut");
t.setFont(Font.font(null, FontWeight.BOLD, 36));

Group g = new Group();
g.getChildren().add(r);
g.getChildren().add(t);

Property Summary

Properties

Type	Property and Description
ObjectProperty<Effect>	bottomInput The bottom input for this Blend operation.
ObjectProperty<BlendMode>	mode The BlendMode used to blend the two inputs together.
DoubleProperty	opacity The opacity value, which is modulated with the top input prior to blending.
ObjectProperty<Effect>	topInput The top input for this Blend operation.

Constructor Summary

Constructors

Constructor and Description
Blend()

Method Summary

Methods

Modifier and Type	Method and Description
ObjectProperty<Effect>	bottomInputProperty() The bottom input for this Blend operation.
Effect	getBottomInput() The bottom input for this Blend operation.
BlendMode	getMode() The BlendMode used to blend the two inputs together.
double	getOpacity() The opacity value, which is modulated with the top input prior to blending.
Effect	getTopInput() The top input for this Blend operation.
ObjectProperty<BlendMode>	modeProperty() The BlendMode used to blend the two inputs together.
DoubleProperty	opacityProperty() The opacity value, which is modulated with the top input prior to blending.
void	setBottomInput(Effect value) The bottom input for this Blend operation.
void	setMode(BlendMode value) The BlendMode used to blend the two inputs together.
void	setOpacity(double value) The opacity value, which is modulated with the top input prior to blending.
void	setTopInput(Effect value) The top input for this Blend operation.
ObjectProperty<Effect>	topInputProperty() The top input for this Blend operation.

Methods inherited from class java.lang.Object

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

Property Detail

mode

The BlendMode used to blend the two inputs together.

       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 

See Also:

getMode(), setMode(BlendMode)

opacity

The opacity value, which is modulated with the top input prior to blending.

       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 

See Also:

getOpacity(), setOpacity(double)

bottomInput

The bottom input for this Blend operation. 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:

getBottomInput(), setBottomInput(Effect)

topInput

The top input for this Blend operation. 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:

getTopInput(), setTopInput(Effect)

Constructor Detail

Blend

public Blend()

Method Detail

setMode

public final void setMode(BlendMode value)

The BlendMode used to blend the two inputs together.

       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 

getMode

public final BlendMode getMode()

The BlendMode used to blend the two inputs together.

       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 

modeProperty

public final ObjectProperty<BlendMode> modeProperty()

The BlendMode used to blend the two inputs together.

       Min: n/a
       Max: n/a
   Default: BlendMode.SRC_OVER
  Identity: n/a
 

See Also:

getMode(), setMode(BlendMode)

setOpacity

public final void setOpacity(double value)

The opacity value, which is modulated with the top input prior to blending.

       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 

getOpacity

public final double getOpacity()

The opacity value, which is modulated with the top input prior to blending.

       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 

opacityProperty

public final DoubleProperty opacityProperty()

The opacity value, which is modulated with the top input prior to blending.

       Min: 0.0
       Max: 1.0
   Default: 1.0
  Identity: 1.0
 

See Also:

getOpacity(), setOpacity(double)

setBottomInput

public final void setBottomInput(Effect value)

The bottom input for this Blend operation. 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.

getBottomInput

public final Effect getBottomInput()

The bottom input for this Blend operation. 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.

bottomInputProperty

public final ObjectProperty<Effect> bottomInputProperty()

The bottom input for this Blend operation. 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:

getBottomInput(), setBottomInput(Effect)

setTopInput

public final void setTopInput(Effect value)

The top input for this Blend operation. 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.

getTopInput

public final Effect getTopInput()

The top input for this Blend operation. 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.

topInputProperty

public final ObjectProperty<Effect> topInputProperty()

The top input for this Blend operation. 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:

getTopInput(), setTopInput(Effect)