Tristan971/EasyFXML

/*
 * Copyright 2017 - 2019 EasyFXML project and contributors
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package moe.tristan.easyfxml.util;

import javafx.scene.shape.Circle;
import javafx.scene.shape.Rectangle;

/**
 * This is a helper class for a few clipping helper methods to make rounded corners rectangles or circles.
 */
public final class Clipping {

    private Clipping() {
    }

    /**
     * Builds a clip-ready rounded corners {@link Rectangle} that is square.
     *
     * @param side          The size of the size of this square
     * @param roundedRadius The radius of this square's corners rounding
     *
     * @return A square with the given side size and rounded corners with the given radius
     */
    public static Rectangle getSquareClip(final double side, final double roundedRadius) {
        final Rectangle rectangle = new Rectangle();
        rectangle.setHeight(side);
        rectangle.setWidth(side);
        rectangle.setArcWidth(roundedRadius);
        rectangle.setArcHeight(roundedRadius);
        return rectangle;
    }

    /**
     * Builds a clip-ready {@link Circle} with a specific radius and specific center position.
     *
     * @param radius  The radius of this circle.
     * @param centerX The horizontal position for this circle's center
     * @param centerY The vertical position for this circle's center
     *
     * @return A circle with the given radius and center position
     */
    private static Circle getCircleClip(final double radius, final double centerX, final double centerY) {
        final Circle clip = new Circle(radius);
        clip.setCenterX(centerX);
        clip.setCenterY(centerY);
        return clip;
    }

    /**
     * Builds a clip-ready {@link Circle} with a specific radius and its center moved so that it is moved to the
     * top-left of its container node.
     *
     * @param radius The radius of the circle in question
     *
     * @return A circle with the given radius
     */
    public static Circle getCircleClip(final double radius) {
        return getCircleClip(radius, radius, radius);
    }

}