com.yworks.yfiles.layout.hierarchic

Class SelfLoopCalculator

java.lang.Object

com.yworks.yfiles.layout.hierarchic.SelfLoopCalculator

public class SelfLoopCalculator
extends Object

This class calculates bend points for self-loops routed in orthogonal or octilinear fashion.

It is used during the layout phase of HierarchicLayoutCore, but can be used as a stand-alone tool.

Field Summary

Fields

Modifier and Type	Field and Description
static EdgeDpKey<Double>	MINIMUM_EDGE_DISTANCE_DPKEY A DataProvider key for specifying the minimum distance to the next edge or node side
static EdgeDpKey<Double>	MINIMUM_FIRST_SEGMENT_LENGTH_DPKEY A DataProvider key for specifying the minimum length of the first segment of each edge
static EdgeDpKey<Double>	MINIMUM_LAST_SEGMENT_LENGTH_DPKEY A DataProvider key for specifying the minimum length of the last segment of each edge
static NodeDpKey<Double>	MINIMUM_NODE_DISTANCE_DPKEY A DataProvider key for defining for each node a minimum distance to the self-loop edges
static EdgeDpKey<Double>	MINIMUM_OCTILINEAR_SEGMENT_LENGTH_DPKEY A DataProvider key for specifying the minimum length of the octilinear segments of an octilinear edge
static EdgeDpKey<Boolean>	OCTILINEAR_EDGES_DPKEY A DataProvider key for specifying whether or not an edge is octilinear

Constructor Summary

Constructors

Constructor and Description
SelfLoopCalculator(double minFirstSegmentLength, double minEdgeDistance) Creates a new instance of SelfLoopCalculator using the given parameters.

Method Summary

Modifier and Type	Method and Description
void	calculateSelfLoops(LayoutGraph graph, Node node, IDataProvider spc, IDataProvider tpc) Calculates all self-loops at the given node of the given input graph.
void	calculateSelfLoops(LayoutGraph graph, Node node, YList selfLoops, IDataProvider spc, IDataProvider tpc) Convenience method that calculates a list of self-loops that belong to a given node.
protected double	getMinimumDistance(LayoutGraph graph, Edge edge) Returns the minimum length between two edges associated with the given edge.
protected double	getMinimumFirstSegmentLength(LayoutGraph graph, Edge edge) Returns the minimum length of the first segment of the given edge.
protected double	getMinimumLastSegmentLength(LayoutGraph graph, Edge edge) Returns the minimum length of the last segment of the given edge.
protected double	getMinimumNodeDistance(LayoutGraph graph, Node node) Returns the minimum distance between two nodes associated with the given node.
protected double	getMinimumOctilinearSegmentLength(LayoutGraph graph, Edge edge) Returns the minimum octilinear segment length of the given edge.
protected boolean	isOctilinearEdge(LayoutGraph graph, Edge edge) Returns whether or not the given edge is octilinear.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINIMUM_EDGE_DISTANCE_DPKEY

public static final EdgeDpKey<Double> MINIMUM_EDGE_DISTANCE_DPKEY

A DataProvider key for specifying the minimum distance to the next edge or node side

MINIMUM_FIRST_SEGMENT_LENGTH_DPKEY

public static final EdgeDpKey<Double> MINIMUM_FIRST_SEGMENT_LENGTH_DPKEY

A DataProvider key for specifying the minimum length of the first segment of each edge

MINIMUM_LAST_SEGMENT_LENGTH_DPKEY

public static final EdgeDpKey<Double> MINIMUM_LAST_SEGMENT_LENGTH_DPKEY

A DataProvider key for specifying the minimum length of the last segment of each edge

MINIMUM_NODE_DISTANCE_DPKEY

public static final NodeDpKey<Double> MINIMUM_NODE_DISTANCE_DPKEY

A DataProvider key for defining for each node a minimum distance to the self-loop edges

MINIMUM_OCTILINEAR_SEGMENT_LENGTH_DPKEY

public static final EdgeDpKey<Double> MINIMUM_OCTILINEAR_SEGMENT_LENGTH_DPKEY

A DataProvider key for specifying the minimum length of the octilinear segments of an octilinear edge

OCTILINEAR_EDGES_DPKEY

public static final EdgeDpKey<Boolean> OCTILINEAR_EDGES_DPKEY

A DataProvider key for specifying whether or not an edge is octilinear

Constructor Detail

SelfLoopCalculator

public SelfLoopCalculator(double minFirstSegmentLength,
                          double minEdgeDistance)

Creates a new instance of SelfLoopCalculator using the given parameters.

Parameters:

minFirstSegmentLength - the minimum length of the first and last segment of an orthogonally routed self-loop

minEdgeDistance - the minimum distance between a pair of self-loops

Method Detail

calculateSelfLoops

public void calculateSelfLoops(LayoutGraph graph,
                               Node node,
                               IDataProvider spc,
                               IDataProvider tpc)

Calculates all self-loops at the given node of the given input graph.

The current port positions will be used for determining the start and end ports. The IDataProvider instances hold information about the source/target ports of the edges and can be used for specifying the direction of first and last segments.

Parameters:

graph - the input graph

node - the node whose self-loops will be routed

spc - the IDataProvider that returns the PortConstraint object associated with the source ports of the edges

tpc - the IDataProvider that returns the PortConstraint object associated with the target ports of the edges

calculateSelfLoops

public void calculateSelfLoops(LayoutGraph graph,
                               Node node,
                               YList selfLoops,
                               IDataProvider spc,
                               IDataProvider tpc)

Convenience method that calculates a list of self-loops that belong to a given node.

The current port positions will be used for determining the start and end ports. The IDataProvider instances hold information about the source/target ports of the edges and can be used for specifying the direction of first and last segments.

Parameters:

graph - the input graph

node - the node whose self-loops will be routed

selfLoops - a list of Edges that will be routed

spc - the IDataProvider that returns the PortConstraint object associated with the source ports of the edges

tpc - the IDataProvider that returns the PortConstraint object associated with the target ports of the edges

getMinimumDistance

protected double getMinimumDistance(LayoutGraph graph,
                                    Edge edge)

Returns the minimum length between two edges associated with the given edge.

The value is fetched from the corresponding IDataProvider registered with the graph with key MINIMUM_EDGE_DISTANCE_DPKEY.

Parameters:

graph - the input graph

edge - the given edge

Returns:

the minimum length between two edges

getMinimumFirstSegmentLength

protected double getMinimumFirstSegmentLength(LayoutGraph graph,
                                              Edge edge)

Returns the minimum length of the first segment of the given edge.

The value is fetched from the corresponding IDataProvider registered with the graph with key MINIMUM_FIRST_SEGMENT_LENGTH_DPKEY.

Parameters:

graph - the input graph

edge - the given edge

Returns:

the minimum length of the first segment of an edge

getMinimumLastSegmentLength

protected double getMinimumLastSegmentLength(LayoutGraph graph,
                                             Edge edge)

Returns the minimum length of the last segment of the given edge.

The value is fetched from the corresponding IDataProvider registered with the graph with key MINIMUM_LAST_SEGMENT_LENGTH_DPKEY.

Parameters:

graph - the input graph

edge - the given edge

Returns:

the minimum length of the last segment of the given edge

getMinimumNodeDistance

protected double getMinimumNodeDistance(LayoutGraph graph,
                                        Node node)

Returns the minimum distance between two nodes associated with the given node.

The value is fetched from the corresponding IDataProvider registered with the graph with key MINIMUM_NODE_DISTANCE_DPKEY.

Parameters:

graph - the input graph

node - the given node

Returns:

the minimum distance between two nodes

getMinimumOctilinearSegmentLength

protected double getMinimumOctilinearSegmentLength(LayoutGraph graph,
                                                   Edge edge)

Returns the minimum octilinear segment length of the given edge.

The value is fetched from the corresponding IDataProvider registered with the graph with key MINIMUM_OCTILINEAR_SEGMENT_LENGTH_DPKEY.

Parameters:

graph - the input graph

edge - the given edge

Returns:

the minimum octilinear segment length of the given edge

isOctilinearEdge

protected boolean isOctilinearEdge(LayoutGraph graph,
                                   Edge edge)

Returns whether or not the given edge is octilinear.

The value is fetched from the corresponding IDataProvider registered with the graph with key OCTILINEAR_EDGES_DPKEY.

Parameters:

graph - the input graph

edge - the given edge

Returns:

true if the edge is octilinear, false otherwise