com.googlecode.blaisemath.geom.Rectangles Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaise-common Show documentation

Common utilities shared across Blaise projects.

There is a newer version: 1.0.10

package com.googlecode.blaisemath.geom;

/*
 * #%L
 * BlaiseCommon
 * --
 * Copyright (C) 2014 - 2019 Elisha Peterson
 * --
 * 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.
 * #L%
 */

import java.awt.geom.Rectangle2D;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Utility class for working with rectangles.
 * @author Elisha Peterson
 */
public class Rectangles {
    
    // utility class
    private Rectangles() {
    }

    /**
     * Return rectangle that is bounding box of all provided.
     * @param rects rectangles
     * @return smallest box enclosing provided rectangles, null if argument is empty
     */
    public static Rectangle2D.@Nullable Double boundingBox(Iterable rects) {
        Rectangle2D res = null;
        for (Rectangle2D r : rects) {
            res = res == null ? r : res.createUnion(r);
        }
        return toDouble(res);
    }
    
    /**
     * Converts a general {@link Rectangle2D} to a {@link Rectangle2D.Double}, returning the argument if it already is.
     * If the input is null, returns null.
     * @param rect input rectangle
     * @return converted rectangle
     */
    public static Rectangle2D.@Nullable Double toDouble(Rectangle2D rect) {
        if (rect == null) {
            return null;
        } else if (rect instanceof Rectangle2D.Double) {
            return (Rectangle2D.Double) rect;
        } else {
            Rectangle2D.Double res = new Rectangle2D.Double();
            res.setFrame(rect);
            return res;
        }
    }
    
}