org.dishevelled.venn.BinaryVennLayout Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dsh-venn Show documentation

Lightweight components for venn diagrams.

There is a newer version: 1.2

/*

    dsh-venn  Lightweight components for venn diagrams.
    Copyright (c) 2009-2013 held jointly by the individual authors.

    This library 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.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out 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 this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.dishevelled.venn;

import java.awt.Shape;

import java.awt.geom.Point2D;

/**
 * Result of a binary venn diagram layout operation.
 *
 * @author  Michael Heuer
 */
public interface BinaryVennLayout extends VennLayout
{

    /**
     * Return the shape for the first set.
     *
     * @return the shape for the first set
     */
    Shape firstShape();

    /**
     * Return the shape for the second set.
     *
     * @return the shape for the second set
     */
    Shape secondShape();

    /**
     * Return the lune center of the first only area.
     *
     * @return the lune center of the first only area
     */
    Point2D firstOnlyLuneCenter(); // todo:  or just firstOnlyCenter()?

    /**
     * Return the lune center of the second only area.
     *
     * @return the lune center of the second only area
     */
    Point2D secondOnlyLuneCenter();

    /**
     * Return the lune center of the intersection area.
     *
     * @return the lune center of the intersection area
     */
    Point2D intersectionLuneCenter();
}