GridGraphLayout.java

/* Copyright (c) 2007-2014 by panayotis.com
 *
 * JavaPlot 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, version 2.
 *
 * JavaPlot is free 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 CrossMobile; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * and open the template in the editor.
 */

package com.panayotis.gnuplot.layout;

import com.panayotis.gnuplot.plot.Page;
import java.io.Serializable;

/**
 * Align graphs evenly on the page, in a grid layout.
 * <p>
 * If you manually set metrics and use this, these metrics will be lost. Do not
 * use this layout, use AutoGraphLayout instead.
 *
 * @author teras
 * @deprecated
 */
public class GridGraphLayout implements GraphLayout, Serializable {

    /**
     * Where the first graph will be put
     */
    public enum Start {

        UPLEFT, UPRIGHT, DOWNLEFT, DOWNRIGHT;
    }
    /**
     * Orientation of the graph layout
     */
    public static final boolean HORIZONTAL = true, VERTICAL = false;
    private Start start;
    private boolean orientation;

    /**
     * Create a new grid layout
     */
    public GridGraphLayout() {
        start = Start.UPLEFT;
        orientation = HORIZONTAL;
    }

    /**
     * Set where the first graph will be put
     *
     * @param start Position of the first graph
     */
    public void setStartPosition(Start start) {
        this.start = start;
    }

    /**
     * Sey the orientation of the graphs, as being put
     *
     * @param orientation Selected orientation
     */
    public void setOrientation(boolean orientation) {
        this.orientation = orientation;
    }

    /**
     * Update the capacity of this layout. This manager tries to create grid, as
     * much square as possible
     *
     * @param page The page with the elements we would like to position
     * @param buffer Where to send commands - not used.
     */
    public void setDefinition(Page page, StringBuilder buffer) {

        int size = page.size();

        if (size <= 0)
            return;

        int width, height;
        height = (int) (Math.floor(Math.sqrt(size)));
        width = (int) Math.ceil((double) size / height);

        float dx = 1f / width;
        float dy = 1f / height;
        int col, lin;
        for (int index = 0; index < size; index++) {
            if (orientation) {
                col = index % width;
                lin = index / width;
            } else {
                lin = index % height;
                col = index / height;
            }

            if (start == Start.UPRIGHT || start == Start.DOWNRIGHT)
                col = width - col - 1;
            if (start == Start.UPLEFT || start == Start.UPRIGHT) // Positioning (0,0) in GNUPlot is in lower left corner
                lin = height - lin - 1;

            page.get(index).setMetrics(dx * col, dy * lin, dx, dy);
        }
    }
}