edu.uci.ics.jung.algorithms.layout.Layout Maven / Gradle / Ivy
/*
* Copyright (c) 2003, the JUNG Project and the Regents of the University
* of California
* All rights reserved.
*
* This software is open-source under the BSD license; see either
* "license.txt" or
* http://jung.sourceforge.net/license.txt for a description.
*/
package edu.uci.ics.jung.algorithms.layout;
import java.awt.Dimension;
import java.awt.geom.Point2D;
import org.apache.commons.collections15.Transformer;
import edu.uci.ics.jung.graph.Graph;
/**
* A generalized interface is a mechanism for returning (x,y) coordinates
* from vertices. In general, most of these methods are used to both control and
* get information from the layout algorithm.
*
* @author danyelf
* @author tom nelson
*/
public interface Layout extends Transformer {
/**
* Initializes fields in the node that may not have
* been set during the constructor. Must be called before
* the iterations begin.
*/
void initialize();
/**
* provides initial locations for all vertices.
* @param initializer
*/
void setInitializer(Transformer initializer);
/**
* setter for graph
* @param graph
*/
void setGraph(Graph graph);
/**
* Returns the full graph (the one that was passed in at
* construction time) that this Layout refers to.
*
*/
Graph getGraph();
/**
*
*
*/
void reset();
/**
* @param d
*/
void setSize(Dimension d);
/**
* Returns the current size of the visualization's space.
*/
Dimension getSize();
/**
* Sets a flag which fixes this vertex in place.
*
* @param v vertex
*/
void lock(V v, boolean state);
/**
* Returns true if the position of vertex v
* is locked.
*/
boolean isLocked(V v);
/**
* set the location of a vertex
* @param v
* @param location
*/
void setLocation(V v, Point2D location);
}