javafx.scene.effect.DropShadow Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.scene.effect;
import javafx.beans.property.DoubleProperty;
import javafx.beans.property.DoublePropertyBase;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.ObjectPropertyBase;
import javafx.scene.Node;
import javafx.scene.paint.Color;
import com.sun.javafx.util.Utils;
import com.sun.javafx.effect.EffectDirtyBits;
import com.sun.javafx.geom.BaseBounds;
import com.sun.javafx.geom.transform.BaseTransform;
import com.sun.javafx.scene.BoundsAccessor;
import com.sun.javafx.tk.Toolkit;
/**
* A high-level effect that renders a shadow of the given content behind
* the content with the specified color, radius, and offset.
*
*
* Example:
*
{@code
* DropShadow dropShadow = new DropShadow();
* dropShadow.setRadius(5.0);
* dropShadow.setOffsetX(3.0);
* dropShadow.setOffsetY(3.0);
* dropShadow.setColor(Color.color(0.4, 0.5, 0.5));
*
* Text text = new Text();
* text.setEffect(dropShadow);
* text.setCache(true);
* text.setX(10.0);
* text.setY(70.0);
* text.setFill(Color.web("0x3b596d"));
* text.setText("JavaFX drop shadow...");
* text.setFont(Font.font(null, FontWeight.BOLD, 40));
*
* DropShadow dropShadow2 = new DropShadow();
* dropShadow2.setOffsetX(6.0);
* dropShadow2.setOffsetY(4.0);
*
* Circle circle = new Circle();
* circle.setEffect(dropShadow2);
* circle.setCenterX(50.0);
* circle.setCenterY(125.0);
* circle.setRadius(30.0);
* circle.setFill(Color.STEELBLUE);
* circle.setCache(true);
* }
*
*
* The code above produces the following:
*
*
* 
*
* @since JavaFX 2.0
*/
public class DropShadow extends Effect {
private boolean changeIsLocal;
/**
* Creates a new instance of DropShadow with default parameters.
*/
public DropShadow() {}
/**
* Creates a new instance of DropShadow with specified radius and color.
* @param radius the radius of the shadow blur kernel
* @param color the shadow {@code Color}
* @since JavaFX 2.1
*/
public DropShadow(double radius, Color color) {
setRadius(radius);
setColor(color);
}
/**
* Creates a new instance of DropShadow with the specified radius, offsetX,
* offsetY and color.
* @param radius the radius of the shadow blur kernel
* @param offsetX the shadow offset in the x direction
* @param offsetY the shadow offset in the y direction
* @param color the shadow {@code Color}
* @since JavaFX 2.1
*/
public DropShadow(double radius, double offsetX, double offsetY, Color color) {
setRadius(radius);
setOffsetX(offsetX);
setOffsetY(offsetY);
setColor(color);
}
/**
* Creates a new instance of DropShadow with the specified blurType, color,
* radius, spread, offsetX and offsetY.
* @param blurType the algorithm used to blur the shadow
* @param color the shadow {@code Color}
* @param radius the radius of the shadow blur kernel
* @param spread the portion of the radius where the contribution of
* the source material will be 100%
* @param offsetX the shadow offset in the x direction
* @param offsetY the shadow offset in the y direction
* @since JavaFX 2.1
*/
public DropShadow(BlurType blurType, Color color, double radius, double spread,
double offsetX, double offsetY) {
setBlurType(blurType);
setColor(color);
setRadius(radius);
setSpread(spread);
setOffsetX(offsetX);
setOffsetY(offsetY);
}
@Override
com.sun.scenario.effect.DropShadow createPeer() {
return new com.sun.scenario.effect.DropShadow();
}
/**
* The input for this {@code Effect}.
* If set to {@code null}, or left unspecified, a graphical image of
* the {@code Node} to which the {@code Effect} is attached will be
* used as the input.
* @defaultValue null
*/
private ObjectProperty input;
public final void setInput(Effect value) {
inputProperty().set(value);
}
public final Effect getInput() {
return input == null ? null : input.get();
}
public final ObjectProperty inputProperty() {
if (input == null) {
input = new EffectInputProperty("input");
}
return input;
}
@Override
boolean checkChainContains(Effect e) {
Effect localInput = getInput();
if (localInput == null)
return false;
if (localInput == e)
return true;
return localInput.checkChainContains(e);
}
/**
* The radius of the shadow blur kernel.
* This attribute controls the distance that the shadow is spread
* to each side of the source pixels.
* Setting the radius is equivalent to setting both the {@code width}
* and {@code height} attributes to a value of {@code (2 * radius + 1)}.
*
* Min: 0.0
* Max: 127.0
* Default: 10.0
* Identity: 0.0
*
* @defaultValue 10.0
*/
private DoubleProperty radius;
public final void setRadius(double value) {
radiusProperty().set(value);
}
public final double getRadius() {
return radius == null ? 10 : radius.get();
}
public final DoubleProperty radiusProperty() {
if (radius == null) {
radius = new DoublePropertyBase(10) {
@Override
public void invalidated() {
// gettter here is necessary to make the property valid
double localRadius = getRadius();
if (!changeIsLocal) {
changeIsLocal = true;
updateRadius(localRadius);
changeIsLocal = false;
markDirty(EffectDirtyBits.EFFECT_DIRTY);
effectBoundsChanged();
}
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "radius";
}
};
}
return radius;
}
private void updateRadius(double value) {
double newdim = (value * 2 + 1);
if (width != null && width.isBound()) {
// if neither is readonly we would set both width and
// height to radius*2+1 (i.e. newdim), but if one of
// them is bound then we need to set the other to a
// value that would map back to the radius we have been
// given.
// To do that we equate the average of the two values
// to newdim, the value we want them both to have, and
// then solve for the missing value:
// avg(w,h) == radius * 2 + 1
// (w+h)/2 == newdim
// w+h == newdim * 2
// h = newdim * 2 - w
// w = newdim * 2 - h
if (height == null || !height.isBound()) {
setHeight(newdim * 2 - getWidth());
}
} else if (height != null && height.isBound()) {
setWidth(newdim * 2 - getHeight());
} else {
setWidth(newdim);
setHeight(newdim);
}
}
/**
* The horizontal size of the shadow blur kernel.
* This attribute controls the horizontal size of the total area over
* which the shadow of a single pixel is distributed by the blur algorithm.
* Values less than {@code 1.0} are not distributed beyond the original
* pixel and so have no blurring effect on the shadow.
*
* Min: 0.0
* Max: 255.0
* Default: 21.0
* Identity: <1.0
*
* @defaultValue 21.0
*/
private DoubleProperty width;
public final void setWidth(double value) {
widthProperty().set(value);
}
public final double getWidth() {
return width == null ? 21 : width.get();
}
public final DoubleProperty widthProperty() {
if (width == null) {
width = new DoublePropertyBase(21) {
@Override
public void invalidated() {
// gettter here is necessary to make the property valid
double localWidth = getWidth();
if (!changeIsLocal) {
changeIsLocal = true;
updateWidth(localWidth);
changeIsLocal = false;
markDirty(EffectDirtyBits.EFFECT_DIRTY);
effectBoundsChanged();
}
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "width";
}
};
}
return width;
}
private void updateWidth(double value) {
if (radius == null || !radius.isBound()) {
double newrad = ((value + getHeight()) / 2);
newrad = ((newrad - 1) / 2);
if (newrad < 0) {
newrad = 0;
}
setRadius(newrad);
} else {
if (height == null || !height.isBound()) {
double newdim = (getRadius() * 2 + 1);
setHeight(newdim * 2 - value);
}
}
}
/**
* The vertical size of the shadow blur kernel.
* This attribute controls the vertical size of the total area over
* which the shadow of a single pixel is distributed by the blur algorithm.
* Values less than {@code 1.0} are not distributed beyond the original
* pixel and so have no blurring effect on the shadow.
*
* Min: 0.0
* Max: 255.0
* Default: 21.0
* Identity: <1.0
*
* @defaultValue 21.0
*/
private DoubleProperty height;
public final void setHeight(double value) {
heightProperty().set(value);
}
public final double getHeight() {
return height == null ? 21 : height.get();
}
public final DoubleProperty heightProperty() {
if (height == null) {
height = new DoublePropertyBase(21) {
@Override
public void invalidated() {
// gettter here is necessary to make the property valid
double localHeight = getHeight();
if (!changeIsLocal) {
changeIsLocal = true;
updateHeight(localHeight);
changeIsLocal = false;
markDirty(EffectDirtyBits.EFFECT_DIRTY);
effectBoundsChanged();
}
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "height";
}
};
}
return height;
}
private void updateHeight(double value) {
if (radius == null || !radius.isBound()) {
double newrad = ((getWidth() + value) / 2);
newrad = ((newrad - 1) / 2);
if (newrad < 0) {
newrad = 0;
}
setRadius(newrad);
} else {
if (width == null || !width.isBound()) {
double newdim = (getRadius() * 2 + 1);
setWidth(newdim * 2 - value);
}
}
}
/**
* The algorithm used to blur the shadow.
*
* Min: n/a
* Max: n/a
* Default: BlurType.THREE_PASS_BOX
* Identity: n/a
*
* @defaultValue THREE_PASS_BOX
*/
private ObjectProperty blurType;
public final void setBlurType(BlurType value) {
blurTypeProperty().set(value);
}
public final BlurType getBlurType() {
return blurType == null ? BlurType.THREE_PASS_BOX : blurType.get();
}
public final ObjectProperty blurTypeProperty() {
if (blurType == null) {
blurType = new ObjectPropertyBase(BlurType.THREE_PASS_BOX) {
@Override
public void invalidated() {
markDirty(EffectDirtyBits.EFFECT_DIRTY);
effectBoundsChanged();
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "blurType";
}
};
}
return blurType;
}
/**
* The spread of the shadow.
* The spread is the portion of the radius where the contribution of
* the source material will be 100%.
* The remaining portion of the radius will have a contribution
* controlled by the blur kernel.
* A spread of {@code 0.0} will result in a distribution of the
* shadow determined entirely by the blur algorithm.
* A spread of {@code 1.0} will result in a solid growth outward of the
* source material opacity to the limit of the radius with a very sharp
* cutoff to transparency at the radius.
*
* Min: 0.0
* Max: 1.0
* Default: 0.0
* Identity: 0.0
*
* @defaultValue 0.0
*/
private DoubleProperty spread;
public final void setSpread(double value) {
spreadProperty().set(value);
}
public final double getSpread() {
return spread == null ? 0.0 : spread.get();
}
public final DoubleProperty spreadProperty() {
if (spread == null) {
spread = new DoublePropertyBase() {
@Override
public void invalidated() {
markDirty(EffectDirtyBits.EFFECT_DIRTY);
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "spread";
}
};
}
return spread;
}
/**
* The shadow {@code Color}.
*
* Min: n/a
* Max: n/a
* Default: Color.BLACK
* Identity: n/a
*
* @defaultValue BLACK
*/
private ObjectProperty color;
public final void setColor(Color value) {
colorProperty().set(value);
}
public final Color getColor() {
return color == null ? Color.BLACK : color.get();
}
public final ObjectProperty colorProperty() {
if (color == null) {
color = new ObjectPropertyBase(Color.BLACK) {
@Override
public void invalidated() {
markDirty(EffectDirtyBits.EFFECT_DIRTY);
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "color";
}
};
}
return color;
}
/**
* The shadow offset in the x direction, in pixels.
*
* Min: n/a
* Max: n/a
* Default: 0.0
* Identity: 0.0
*
* @defaultValue 0.0
*/
private DoubleProperty offsetX;
public final void setOffsetX(double value) {
offsetXProperty().set(value);
}
public final double getOffsetX() {
return offsetX == null ? 0 : offsetX.get();
}
public final DoubleProperty offsetXProperty() {
if (offsetX == null) {
offsetX = new DoublePropertyBase() {
@Override
public void invalidated() {
markDirty(EffectDirtyBits.EFFECT_DIRTY);
effectBoundsChanged();
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "offsetX";
}
};
}
return offsetX;
}
/**
* The shadow offset in the y direction, in pixels.
*
* Min: n/a
* Max: n/a
* Default: 0.0
* Identity: 0.0
*
* @defaultValue 0.0
*/
private DoubleProperty offsetY;
public final void setOffsetY(double value) {
offsetYProperty().set(value);
}
public final double getOffsetY() {
return offsetY == null ? 0 : offsetY.get();
}
public final DoubleProperty offsetYProperty() {
if (offsetY == null) {
offsetY = new DoublePropertyBase() {
@Override
public void invalidated() {
markDirty(EffectDirtyBits.EFFECT_DIRTY);
effectBoundsChanged();
}
@Override
public Object getBean() {
return DropShadow.this;
}
@Override
public String getName() {
return "offsetY";
}
};
}
return offsetY;
}
private float getClampedWidth() {
return (float) Utils.clamp(0, getWidth(), 255);
}
private float getClampedHeight() {
return (float) Utils.clamp(0, getHeight(), 255);
}
private float getClampedSpread() {
return (float) Utils.clamp(0, getSpread(), 1);
}
private Color getColorInternal() {
Color c = getColor();
return c == null ? Color.BLACK : c;
}
private BlurType getBlurTypeInternal() {
BlurType bt = getBlurType();
return bt == null ? BlurType.THREE_PASS_BOX : bt;
}
@Override
void update() {
Effect localInput = getInput();
if (localInput != null) {
localInput.sync();
}
com.sun.scenario.effect.DropShadow peer =
(com.sun.scenario.effect.DropShadow) getPeer();
peer.setShadowSourceInput(localInput == null ? null : localInput.getPeer());
peer.setContentInput(localInput == null ? null : localInput.getPeer());
peer.setGaussianWidth(getClampedWidth());
peer.setGaussianHeight(getClampedHeight());
peer.setSpread(getClampedSpread());
peer.setShadowMode(Toolkit.getToolkit().toShadowMode(getBlurTypeInternal()));
peer.setColor(Toolkit.getToolkit().toColor4f(getColorInternal()));
peer.setOffsetX((int) getOffsetX());
peer.setOffsetY((int) getOffsetY());
}
@Override
BaseBounds getBounds(BaseBounds bounds,
BaseTransform tx,
Node node,
BoundsAccessor boundsAccessor) {
bounds = getInputBounds(bounds,
BaseTransform.IDENTITY_TRANSFORM,
node, boundsAccessor,
getInput());
int shadowX = (int) getOffsetX();
int shadowY = (int) getOffsetY();
BaseBounds shadowBounds = BaseBounds.getInstance(bounds.getMinX() + shadowX,
bounds.getMinY() + shadowY,
bounds.getMinZ(),
bounds.getMaxX() + shadowX,
bounds.getMaxY() + shadowY,
bounds.getMaxZ());
shadowBounds = getShadowBounds(shadowBounds, tx,
getClampedWidth(),
getClampedHeight(),
getBlurTypeInternal());
BaseBounds contentBounds = transformBounds(tx, bounds);
BaseBounds ret = contentBounds.deriveWithUnion(shadowBounds);
return ret;
}
@Override
Effect copy() {
DropShadow d = new DropShadow(this.getBlurType(), this.getColor(),
this.getRadius(), this.getSpread(), this.getOffsetX(),
this.getOffsetY());
d.setInput(this.getInput());
d.setWidth(this.getWidth());
d.setHeight(this.getHeight());
return d;
}
}