com.yworks.yfiles.layout.hierarchic

Interface IDrawingDistanceCalculator

All Known Implementing Classes:

DefaultDrawingDistanceCalculator, TypeBasedDrawingDistanceCalculator

public interface IDrawingDistanceCalculator

This interface determines the minimum distances between elements that belong to the same layer.

IDrawingDistanceCalculator is implemented by a helper class used by HierarchicLayoutCore during the phase of node placement (i.e. when the final coordinates for all nodes are calculated). INodePlacer uses instances of this interface to determine the minimum distances between elements that belong to the same layer.

Information about graph elements (i.e. nodes or edges) is given using a ILayoutDataProvider while information about layers is given through ILayer (describes a single layer of the hierarchic layout) or ILayers (manages multiple layers of the hierarchic layout).

Implementations not needed any more should be disposed of.

The default implementation used by the HierarchicLayoutCore is DefaultDrawingDistanceCalculator.

Method Summary

Modifier and Type	Method and Description
void	dispose(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Disposes of internal data structures.
double	getMinDistance(LayoutGraph graph, ILayer layer, ILayoutDataProvider ldp, Node left, Node right) Main interface method called by INodePlacer instances to determine the minimum distance between Nodes of same layer.
void	initialize(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Initializes internal data structures.

Method Detail

dispose

void dispose(LayoutGraph graph,
             ILayers layers,
             ILayoutDataProvider ldp)

Disposes of internal data structures.

Implementations should release internally held data structures when they are not needed any more.

Parameters:

graph - the input graph that contains all elements that are used during the node placement

layers - the ILayers object that will be used during subsequent calls

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

See Also:

initialize(LayoutGraph, ILayers, ILayoutDataProvider)

getMinDistance

double getMinDistance(LayoutGraph graph,
                      ILayer layer,
                      ILayoutDataProvider ldp,
                      Node left,
                      Node right)

Main interface method called by INodePlacer instances to determine the minimum distance between Nodes of same layer.

One of Node arguments may be null if its border is not of interest. In that case, only the border of the non-null Node instance should be considered.

Parameters:

graph - the input graph

layer - the ILayer object that will be used during subsequent calls

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

left - the left of the two Nodes whose minimum distance is to be determined or null if only the left border of the right Node is of interest

right - the right of the two Nodes whose minimum distance is to be determined or null if only the right border of the left Node is of interest

Returns:

the minimum distance between two Nodes of the same layer

initialize

void initialize(LayoutGraph graph,
                ILayers layers,
                ILayoutDataProvider ldp)

Initializes internal data structures.

Implementations may cache lengthy calculations in the initialization phase.

It is guaranteed that the graph will not be changed during subsequent calls to getMinDistance(LayoutGraph, ILayer, ILayoutDataProvider, Node, Node).

Parameters:

graph - the input graph that contains all elements that are used during the node placement

layers - the ILayers object that will be used during subsequent calls

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

See Also:

dispose(LayoutGraph, ILayers, ILayoutDataProvider)