org.eth.cyril.graphdrawing.graph.edge

Interface DrawableEdge

All Known Implementing Classes:

BendedDrawableEdge, DirectDrawableEdge

public interface DrawableEdge

A Drawable edge is used by GraphDrawer instances to draw the edge correctly. Specifying all intermediate positions allows for example to add bends to edges, such as long edges used in the Sugiyama layout algorithm.

Method Summary

Modifier and Type	Method and Description
java.util.List<Position>	intermediatePositions(Position from, Position to) Returns a list of intermediate positions on the path from to to.
void	invert() Inverts this drawable edge by inverting the possible intermediate positions which can be returned.
default DrawableEdge	relativize(Position from, Position to) Returns a DrawableEdge with positions relative to the given from and to position, instead of containing absolute positions.

Method Detail

intermediatePositions

java.util.List<Position> intermediatePositions(Position from,
                                               Position to)

Returns a list of intermediate positions on the path from to to. The two given positions are also given in this list, as the first and last element, respectively.

Parameters:

from - The position where this drawable edge starts.

to - The position where this drawable edge ends.

Returns:

A list of intermediate positions. The "from" position is the first element of this list, the "to" position is the last element.

invert

void invert()

Inverts this drawable edge by inverting the possible intermediate positions which can be returned.

relativize

default DrawableEdge relativize(Position from,
                                Position to)

Returns a DrawableEdge with positions relative to the given from and to position, instead of containing absolute positions.

Parameters:

from - The position where this drawable edge starts.

to - The position where this drawable edge ends.

Returns:

A list of intermediate positions. The "from" position is the first element of this list, the "to" position is the last element.