io.github.palexdev.mfxeffects.ripple.base.RippleGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation
Material Design/Modern components for JavaFX, now packed as a single Jar
There is a newer version: 11.26.0
package io.github.palexdev.mfxeffects.ripple.base;

import io.github.palexdev.mfxeffects.beans.Position;
import io.github.palexdev.mfxeffects.beans.Size;
import io.github.palexdev.mfxeffects.beans.properties.styleable.StyleableSizeProperty;
import javafx.css.StyleableBooleanProperty;
import javafx.css.StyleableObjectProperty;
import javafx.scene.layout.Region;
import javafx.scene.paint.Color;

import java.util.function.Supplier;

/**
 * Public API that all ripple generators should expose.
 */
public interface RippleGenerator {

    /**
     * By default, does nothing.
     * 
     * Optionally generators can implement this convenience method to enable the generation of effects
     * on the target region.
     */
    default void enable() {
    }

    /**
     * By default, does nothing.
     * 

     * Optionally generators can implement this convenience method to disable the generation of effects
     * on the target region.
     */
    default void disable() {
    }

    /**
     * This is the core method responsible for generating ripple effects.
     * 

     * Should define the first phase of the effect, the generation.
     *
     * @see #release()
     */
    void generate(double x, double y);

    /**
     * Opposite of {@link #generate(double, double)}.
     * 

     * Should define the second phase of the effect, the fading out
     * 

     * This is optional, implementations can also rely on a single phase.
     */
    void release();

    /**
     * Shortcut for {@code generate(pos.getX(), pos.getY())}.
     */
    default void generate(Position pos) {
        generate(pos.getX(), pos.getY());
    }

    /**
     * Implementation can specify the actions needed for the generator's disposal.
     * By default, does nothing.
     */
    default void dispose() {
    }

    /**
     * @return the target region which defines some of the core generator's properties, like its geometry, and
     * it's also needed to add the handlers on it
     */
    Region getOwner();

    /**
     * @return the {@link Supplier} used by the generator to clip itself, thus avoiding ripples from
     * overflowing
     */
    Supplier getClipSupplier();

    /**
     * Sets the {@link Supplier} used by the generator to clip itself, thus avoiding ripples from
     * overflowing.
     */
    void setClipSupplier(Supplier clipSupplier);

    /**
     * @return the {@link Supplier} used by the generator to create ripples
     */
    Supplier> getRippleSupplier();

    /**
     * Sets the {@link Supplier} used by the generator to create ripples.
     */
    void setRippleSupplier(Supplier> rippleSupplier);

    /**
     * @return the preferred, default type of ripple the generator uses
     */
    Supplier> defaultRippleSupplier();

    boolean doAnimateBackground();

    /**
     * Specifies whether the generator should also animate its background color.
     */
    StyleableBooleanProperty animateBackgroundProperty();

    void setAnimateBackground(boolean animateBackground);

    Color getBackgroundColor();

    /**
     * Specifies the background color to use when animating it, see {@link #animateBackgroundProperty()}.
     */
    StyleableObjectProperty backgroundColorProperty();

    void setBackgroundColor(Color backgroundColor);

    Color getRippleColor();

    /**
     * Specifies ripple node color.
     */
    StyleableObjectProperty rippleColorProperty();

    void setRippleColor(Color rippleColor);

    Size getRipplePrefSize();

    /**
     * Specifies the preferred size of the ripple node.
     */
    StyleableSizeProperty ripplePrefSizeProperty();

    void setRipplePrefSize(Size ripplePrefSize);
}