All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javafx.scene.effect.Shadow Maven / Gradle / Ivy

There is a newer version: 24-ea+15
Show newest version
/*
 * 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;


/**
 * An effect which creates a monochrome duplicate of an input with
 * blurry edges.
 * This effect is primarily used along with its default black color for
 * purposes of combining it with the original to create a shadow.
 * It can also be used with a light color and combined with an original
 * to create a glow effect.
 * The {@link DropShadow} effect is a utility effect which automatically
 * combines this {@code Shadow} effect with an original graphic for ease
 * of adding a shadow to an existing scene graph {@code Node} with a
 * single effect.
 * @since JavaFX 2.0
 */
public class Shadow extends Effect {
    private boolean changeIsLocal;

    /**
     * Creates a new instance of Shadow with default parameters.
     */
    public Shadow() {}

    /**
     * Creates a new instance of Shadow 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 Shadow(double radius, Color color) {
        setRadius(radius);
        setColor(color);
    }

    /**
     * Creates a new instance of Shadow with the specified blurType, color,
     * radius.
     * @param blurType the algorithm used to blur the shadow
     * @param color the shadow {@code Color}
     * @param radius the radius of the shadow blur kernel
     * @since JavaFX 2.1
     */
    public Shadow(BlurType blurType, Color color, double radius) {
        setBlurType(blurType);
        setColor(color);
        setRadius(radius);
    }

    @Override
    com.sun.scenario.effect.GeneralShadow createPeer() {
        return new com.sun.scenario.effect.GeneralShadow();
    }
    /**
     * 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 Shadow.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 (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 Shadow.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 { // special case when radius is bound 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 Shadow.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 Shadow.this; } @Override public String getName() { return "blurType"; } }; } return blurType; } /** * 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 Shadow.this; } @Override public String getName() { return "color"; } }; } return color; } private float getClampedWidth() { return (float) Utils.clamp(0, getWidth(), 255); } private float getClampedHeight() { return (float) Utils.clamp(0, getHeight(), 255); } 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.GeneralShadow peer = (com.sun.scenario.effect.GeneralShadow) getPeer(); peer.setInput(localInput == null ? null : localInput.getPeer()); peer.setGaussianWidth(getClampedWidth()); peer.setGaussianHeight(getClampedHeight()); peer.setShadowMode(Toolkit.getToolkit().toShadowMode(getBlurTypeInternal())); peer.setColor(Toolkit.getToolkit().toColor4f(getColorInternal())); } @Override BaseBounds getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor) { bounds = getInputBounds(bounds, BaseTransform.IDENTITY_TRANSFORM, node, boundsAccessor, getInput()); return getShadowBounds(bounds, tx, getClampedWidth(), getClampedHeight(), getBlurTypeInternal()); } @Override Effect copy() { Shadow shadow = new Shadow(this.getBlurType(), this.getColor(), this.getRadius()); shadow.setInput(this.getInput()); shadow.setHeight(this.getHeight()); shadow.setWidth(this.getWidth()); return shadow; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy