io.github.palexdev.mfxcore.base.beans.CustomBounds 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
/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
 *
 * MaterialFX is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * MaterialFX 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX. If not, see .
 */

package io.github.palexdev.mfxcore.base.beans;

import javafx.geometry.BoundingBox;
import javafx.geometry.Bounds;

/**
 * JavaFX allows you to create custom {@code Bounds} objects, see {@link BoundingBox}, the thing is
 * that it automatically computes the max X/Y/Z values. This can be quite unfortunate in some rare
 * cases because maybe you need some kind of special bounds, this bean is specifically for such edge cases.
 */
public class CustomBounds {
	//================================================================================
	// Properties
	//================================================================================
	private final double minX;
	private final double minY;
	private final double minZ;
	private final double maxX;
	private final double maxY;
	private final double maxZ;
	private final double width;
	private final double height;

	//================================================================================
	// Constructors
	//================================================================================
	public CustomBounds(double minX, double minY, double maxX, double maxY, double width, double height) {
		this(minX, minY, 0, maxX, maxY, 0, width, height);
	}

	public CustomBounds(double minX, double minY, double minZ, double maxX, double maxY, double maxZ, double width, double height) {
		this.minX = minX;
		this.minY = minY;
		this.minZ = minZ;
		this.maxX = maxX;
		this.maxY = maxY;
		this.maxZ = maxZ;
		this.width = width;
		this.height = height;
	}

	//================================================================================
	// Static Methods
	//================================================================================

	/**
	 * @return a copy of the given {@link Bounds} object as a {@code CustomBounds} object.
	 */
	public static CustomBounds from(Bounds bounds) {
		return new CustomBounds(
				bounds.getMinX(),
				bounds.getMinY(),
				bounds.getMinZ(),
				bounds.getMaxX(),
				bounds.getMaxY(),
				bounds.getMaxY(),
				bounds.getWidth(),
				bounds.getHeight()
		);
	}

	//================================================================================
	// Getters/Setters
	//================================================================================
	public double getMinX() {
		return minX;
	}

	public double getMinY() {
		return minY;
	}

	public double getMinZ() {
		return minZ;
	}

	public double getMaxX() {
		return maxX;
	}

	public double getMaxY() {
		return maxY;
	}

	public double getMaxZ() {
		return maxZ;
	}

	public double getWidth() {
		return width;
	}

	public double getHeight() {
		return height;
	}
}