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

org.jfree.chart3d.graphics2d.Anchor2D Maven / Gradle / Ivy

/* ===========================================================
 * Orson Charts : a 3D chart library for the Java(tm) platform
 * ===========================================================
 * 
 * (C)opyright 2013-2020, by Object Refinery Limited.  All rights reserved.
 * 
 * https://github.com/jfree/orson-charts
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 * 
 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
 * Other names may be trademarks of their respective owners.]
 * 
 * If you do not wish to be bound by the terms of the GPL, an alternative
 * commercial license can be purchased.  For details, please see visit the
 * Orson Charts home page:
 * 
 * http://www.object-refinery.com/orsoncharts/index.html
 * 
 */

package org.jfree.chart3d.graphics2d;

import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.io.Serializable;
import org.jfree.chart3d.TitleAnchor;
import org.jfree.chart3d.graphics3d.Offset2D;
import org.jfree.chart3d.internal.Args;
import org.jfree.chart3d.legend.LegendAnchor;

/**
 * Represents an anchor point for a chart title and/or legend.  The anchor
 * point is defined relative to a reference rectangle, the dimensions of which
 * are not known in advance (typically the reference rectangle is the bounding
 * rectangle of a chart that is being drawn).  Some predefined anchor points 
 * are provided in the {@link TitleAnchor} and {@link LegendAnchor} classes.  
 * 

* Instances of this class are immutable. *

* NOTE: This class is serializable, but the serialization format is subject * to change in future releases and should not be relied upon for persisting * instances of this class. */ @SuppressWarnings("serial") public final class Anchor2D implements Serializable { /** * An anchor point at the top left with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D TOP_LEFT = new Anchor2D(RefPt2D.TOP_LEFT, Offset2D.ZERO_OFFSET); /** * An anchor point at the top center with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D TOP_CENTER = new Anchor2D(RefPt2D.TOP_CENTER, Offset2D.ZERO_OFFSET); /** * An anchor point at the top right with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D TOP_RIGHT = new Anchor2D(RefPt2D.TOP_RIGHT, Offset2D.ZERO_OFFSET); /** * An anchor point at the center left with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D CENTER_LEFT = new Anchor2D(RefPt2D.CENTER_LEFT, Offset2D.ZERO_OFFSET); /** * An anchor point at the center of the target rectangle. * * @since 1.1 */ public static final Anchor2D CENTER = new Anchor2D(RefPt2D.CENTER, Offset2D.ZERO_OFFSET); /** * An anchor point at the center right with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D CENTER_RIGHT = new Anchor2D(RefPt2D.CENTER_RIGHT, Offset2D.ZERO_OFFSET); /** * An anchor point at the bottom left with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D BOTTOM_LEFT = new Anchor2D(RefPt2D.BOTTOM_LEFT, Offset2D.ZERO_OFFSET); /** * An anchor point at the bottom center with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D BOTTOM_CENTER = new Anchor2D(RefPt2D.BOTTOM_CENTER, Offset2D.ZERO_OFFSET); /** * An anchor point at the bottom right with zero offset from the target * rectangle bounds. * * @since 1.1 */ public static final Anchor2D BOTTOM_RIGHT = new Anchor2D(RefPt2D.BOTTOM_RIGHT, Offset2D.ZERO_OFFSET); /** * The reference point relative to some bounding rectangle, normally the * bounds of the chart (never {@code null}). */ private RefPt2D refPt; /** * The offsets to apply (never {@code null}). */ private Offset2D offset; /** * Creates a default instance. */ public Anchor2D() { this(RefPt2D.TOP_LEFT); } /** * Creates a new {@code Anchor2D} instance with the specified * reference point and offsets of {@code (4.0, 4.0)}. * * @param refPt the reference point ({@code null} not permitted). */ public Anchor2D(RefPt2D refPt) { this(refPt, new Offset2D(4.0, 4.0)); } /** * Creates a new anchor. * * @param refPt the reference point ({@code null} not permitted). * @param offset the offset ({@code null} not permitted). */ public Anchor2D(RefPt2D refPt, Offset2D offset) { Args.nullNotPermitted(refPt, "refPt"); Args.nullNotPermitted(offset, "offset"); this.refPt = refPt; this.offset = offset; } /** * Returns the reference point. * * @return The reference point (never {@code null}). */ public RefPt2D getRefPt() { return this.refPt; } /** * Returns the offsets. * * @return The offsets (never {@code null}). */ public Offset2D getOffset() { return this.offset; } /** * Returns the anchor point for the given rectangle. * * @param rect the reference rectangle ({@code null} not permitted). * * @return The anchor point. */ public Point2D getAnchorPoint(Rectangle2D rect) { Args.nullNotPermitted(rect, "rect"); double x = 0.0; double y = 0.0; if (this.refPt.isLeft()) { x = rect.getX() + this.offset.getDX(); } else if (this.refPt.isHorizontalCenter()) { x = rect.getCenterX(); } else if (this.refPt.isRight()) { x = rect.getMaxX() - this.offset.getDX(); } if (this.refPt.isTop()) { y = rect.getMinY() + this.offset.getDY(); } else if (this.refPt.isVerticalCenter()) { y = rect.getCenterY(); } else if (this.refPt.isBottom()) { y = rect.getMaxY() - this.offset.getDY(); } return new Point2D.Double(x, y); } /** * Resolves the anchor to a specific point relative to a rectangle defined * by the points (startX, startY) and (endX, endY). * * @param startX the x-coordinate for the bottom left corner of the target * rect. * @param startY the y-coordinate for the bottom left corner of the target * rect. * @param endX the x-coordinate for the top right corner of the target * rect. * @param endY the y-coordinate for the top right corner of the target * rect. * * @return The resolved point. * * @since 1.2 */ public Point2D resolveAnchorWithPercentOffset(double startX, double startY, double endX, double endY) { double x = 0.0; double y = 0.0; if (this.refPt.isLeft()) { x = startX + this.offset.getDX() * (endX - startX); } else if (this.refPt.isHorizontalCenter()) { x = (startX + endX) / 2.0; } else if (this.refPt.isRight()) { x = endX - this.offset.getDX() * (endX - startX); } if (this.refPt.isTop()) { y = endY - this.offset.getDY() * (endY - startY); } else if (this.refPt.isVerticalCenter()) { y = (startY + endY) / 2.0; } else if (this.refPt.isBottom()) { y = startY + this.offset.getDY() * (endY - startY); } return new Point2D.Double(x, y); } /** * Tests this instance for equality with an arbitrary object. * * @param obj the object ({@code null} not permitted). * * @return A boolean. */ @Override public boolean equals(Object obj) { if (obj == this) { return true; } if (!(obj instanceof Anchor2D)) { return false; } Anchor2D that = (Anchor2D) obj; if (!this.refPt.equals(that.refPt)) { return false; } if (!this.offset.equals(that.offset)) { return false; } return true; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy