org.graphstream.ui.layout.springbox.implementations.SpringBox Maven / Gradle / Ivy

/*
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */

/**
 * @since 2012-06-19
 * 
 * @author Antoine Dutot 
 * @author Guilhelm Savin 
 * @author Hicham Brahimi 
 */
package org.graphstream.ui.layout.springbox.implementations;

import java.util.Random;

import org.graphstream.ui.layout.LayoutRunner;
import org.graphstream.ui.layout.springbox.BarnesHutLayout;
import org.graphstream.ui.layout.springbox.NodeParticle;

/**
 * The GraphStream Spring-Box layout.
 * 
 * 
 * This layout is the default GraphStream layout that handles dynamic graphs. It
 * can constantly evolve according to the changes in the graph. And works well
 * with the {@link LayoutRunner} class so that the computations stops when the
 * layout is stable enougth.
 * 
 * 
 * 
 * This algorithm is based on the Frutcherman-Reingold force layout algorithm
 * modified on the attraction (the degree of nodes is taken into account to
 * stabilize the layout as we are not only interested in the result, but also in
 * the steps in between).
 * 
 */
public class SpringBox extends BarnesHutLayout {
	/**
	 * The optimal distance between nodes.
	 */
	protected double k = 1f;

	/**
	 * Default attraction.
	 */
	protected double K1 = 0.06f; // 0.3 ??

	/**
	 * Default repulsion.
	 */
	protected double K2 = 0.024f; // 0.12 ??

	/**
	 * New "Spring-Box" 2D Barnes-Hut simulation.
	 */
	public SpringBox() {
		this(false);
	}

	/**
	 * New "Spring-Box" Barnes-Hut simulation.
	 * 
	 * @param is3D
	 *            If true the simulation dimensions count is 3 else 2.
	 */
	public SpringBox(boolean is3D) {
		this(is3D, new Random(System.currentTimeMillis()));
	}

	/**
	 * New "Spring-Box" Barnes-Hut simulation.
	 * 
	 * @param is3D
	 *            If true the simulation dimensions count is 3 else 2.
	 * @param randomNumberGenerator
	 *            The random number generator to use.
	 */
	public SpringBox(boolean is3D, Random randomNumberGenerator) {
		super(is3D, randomNumberGenerator);
		setQuality(0.1);
	}

	@Override
	public String getLayoutAlgorithmName() {
		return "SpringBox";
	}

	@Override
	public void setQuality(double qualityLevel) {
		super.setQuality(qualityLevel);

		if (quality >= 1) {
			viewZone = -1;
		} else if (quality <= 0) {
			viewZone = k;
		} else {
			viewZone = k + (k * 10 * quality);
		}
	}

	@Override
	protected void chooseNodePosition(NodeParticle n0, NodeParticle n1) {
		if (n0.frozen || n1.frozen)
			return;

		double delta = random.nextDouble(); // k * 0.1;
		if (n0.getEdges().size() == 1 && n1.getEdges().size() > 1) {
			org.miv.pherd.geom.Point3 pos = n1.getPosition();
			n0.moveTo(pos.x + delta, pos.y + delta, pos.z + delta);
		} else if (n1.getEdges().size() == 1 && n0.getEdges().size() > 1) {
			org.miv.pherd.geom.Point3 pos = n0.getPosition();
			n1.moveTo(pos.x + delta, pos.y + delta, pos.z + delta);
		}
	}

	@Override
	public NodeParticle newNodeParticle(String id) {
		return new SpringBoxNodeParticle(this, id);
	}
}