com.yworks.yfiles.layout.router.polyline

Class EdgeLayoutDescriptor

java.lang.Object

com.yworks.yfiles.layout.router.polyline.EdgeLayoutDescriptor

public class EdgeLayoutDescriptor
extends Object

This class is used by EdgeRouter to provide routing details for the edges of the graph.

An EdgeLayoutDescriptor instance can be specified individually for single edges using a IDataProvider that returns an EdgeLayoutDescriptor instance for each edge of the graph, or null if no EdgeLayoutDescriptor is bound to an edge. The IDataProvider is registered with the graph using key EdgeRouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY.

This class is designed such that it allows future additions of new getter methods.

Not all of the values contained in this class will be considered for all kinds of edges and algorithm settings.

See Also:

EdgeRouter.EDGE_LAYOUT_DESCRIPTOR_DPKEY

Constructor Summary

Constructors

Constructor and Description
EdgeLayoutDescriptor() Creates a new instance of an EdgeLayoutDescriptor with the default settings.

Method Summary

Modifier and Type	Method and Description
EdgeLayoutDescriptor	createCopy() Creates a copy of this EdgeLayoutDescriptor instance.
double	getMinimumEdgeToEdgeDistance() Gets the minimum distance between a pair of edges.
double	getMinimumFirstSegmentLength() Gets the minimum length of the first segment of the edge path (at the source node).
double	getMinimumLastSegmentLength() Gets the minimum length of the last segment of the edge path (at the target node).
double	getMinimumNodeCornerDistance() Gets the minimum distance that the edge should maintain from node corners when entering or leaving the node.
MonotonicPathRestriction	getMonotonicPathRestriction() Gets the monotonic path restrictions that should be applied.
PenaltySettings	getPenaltySettings() Gets the PenaltySettings used for this edge.
void	setMinimumEdgeToEdgeDistance(double value) Sets the minimum distance between a pair of edges.
void	setMinimumFirstSegmentLength(double value) Sets the minimum length of the first segment of the edge path (at the source node).
void	setMinimumLastSegmentLength(double value) Sets the minimum length of the last segment of the edge path (at the target node).
void	setMinimumNodeCornerDistance(double value) Sets the minimum distance that the edge should maintain from node corners when entering or leaving the node.
void	setMonotonicPathRestriction(MonotonicPathRestriction value) Sets the monotonic path restrictions that should be applied.
void	setPenaltySettings(PenaltySettings value) Sets the PenaltySettings used for this edge.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeLayoutDescriptor

public EdgeLayoutDescriptor()

Creates a new instance of an EdgeLayoutDescriptor with the default settings.

Method Detail

createCopy

public EdgeLayoutDescriptor createCopy()

Creates a copy of this EdgeLayoutDescriptor instance.

Returns:

a copy of this EdgeLayoutDescriptor instance

getMinimumEdgeToEdgeDistance

public double getMinimumEdgeToEdgeDistance()

Gets the minimum distance between a pair of edges.

The minimum distance should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 3.0, will be used instead.

Default Value:

The default value is 3.0.

Returns:

the minimum distance between a pair of edges

See Also:

setMinimumEdgeToEdgeDistance(double)

getMinimumFirstSegmentLength

public double getMinimumFirstSegmentLength()

Gets the minimum length of the first segment of the edge path (at the source node).

The minimum length should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 5.0, will be used instead.

The final segment length also depends on the used grid size (see Spacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 5.0.

Returns:

the minimum length of the first segment

See Also:

setMinimumFirstSegmentLength(double)

getMinimumLastSegmentLength

public double getMinimumLastSegmentLength()

Gets the minimum length of the last segment of the edge path (at the target node).

The minimum length should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 10.0, will be used instead.

The final segment length also depends on the used grid size (see Spacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 10.0.

Returns:

the minimum length of the last segment

See Also:

setMinimumLastSegmentLength(double)

getMinimumNodeCornerDistance

public double getMinimumNodeCornerDistance()

Gets the minimum distance that the edge should maintain from node corners when entering or leaving the node.

The minimum distance should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 3.0, will be used instead.

Default Value:

The default value is 3.0.

Returns:

the minimum distance the edge should maintain from node corners

See Also:

setMinimumNodeCornerDistance(double)

getMonotonicPathRestriction

public MonotonicPathRestriction getMonotonicPathRestriction()

Gets the monotonic path restrictions that should be applied.

Monotonic path restrictions imply that (ideally) the vertical and/or horizontal segments of an edge path are directed from the source node towards the target node without ever changing their direction back towards the source node.

If an unknown restriction is specified, MonotonicPathRestriction.NONE will be used instead.

Default Value:

The default value is MonotonicPathRestriction.NONE. No path restrictions are used.

Returns:

one of the predefined monotonic path restrictions

See Also:

setMonotonicPathRestriction(MonotonicPathRestriction)

getPenaltySettings

public PenaltySettings getPenaltySettings()

Gets the PenaltySettings used for this edge.

Besides specifying a completely customized setting, the user can choose between four predefined optimization strategies: PenaltySettings.OPTIMIZATION_BALANCED, PenaltySettings.OPTIMIZATION_EDGE_BENDS, PenaltySettings.OPTIMIZATION_EDGE_CROSSINGS and PenaltySettings.OPTIMIZATION_EDGE_LENGTHS.

Throws:

IllegalArgumentException - if the given penalty settings are null

Returns:

the penalty settings used for this edge

See Also:

PenaltySettings.OPTIMIZATION_BALANCED, PenaltySettings.OPTIMIZATION_EDGE_BENDS, PenaltySettings.OPTIMIZATION_EDGE_CROSSINGS, PenaltySettings.OPTIMIZATION_EDGE_LENGTHS, setPenaltySettings(PenaltySettings)

setMinimumEdgeToEdgeDistance

public void setMinimumEdgeToEdgeDistance(double value)

Sets the minimum distance between a pair of edges.

The minimum distance should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 3.0, will be used instead.

Default Value:

The default value is 3.0.

Parameters:

value - the minimum distance between a pair of edges

See Also:

getMinimumEdgeToEdgeDistance()

setMinimumFirstSegmentLength

public void setMinimumFirstSegmentLength(double value)

Sets the minimum length of the first segment of the edge path (at the source node).

The minimum length should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 5.0, will be used instead.

The final segment length also depends on the used grid size (see Spacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 5.0.

Parameters:

value - the minimum length of the first segment

See Also:

getMinimumFirstSegmentLength()

setMinimumLastSegmentLength

public void setMinimumLastSegmentLength(double value)

Sets the minimum length of the last segment of the edge path (at the target node).

The minimum length should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 10.0, will be used instead.

The final segment length also depends on the used grid size (see Spacing). If the grid is larger than the specified minimum length, then the grid size defines the actual minimum.

Default Value:

The default value is 10.0.

Parameters:

value - the minimum length of the last segment

See Also:

getMinimumLastSegmentLength()

setMinimumNodeCornerDistance

public void setMinimumNodeCornerDistance(double value)

Sets the minimum distance that the edge should maintain from node corners when entering or leaving the node.

The minimum distance should be greater than or equal to 0. If a negative value is given as input, the default value, i.e., 3.0, will be used instead.

Default Value:

The default value is 3.0.

Parameters:

value - the minimum distance the edge should maintain from node corners

See Also:

getMinimumNodeCornerDistance()

setMonotonicPathRestriction

public void setMonotonicPathRestriction(MonotonicPathRestriction value)

Sets the monotonic path restrictions that should be applied.

Monotonic path restrictions imply that (ideally) the vertical and/or horizontal segments of an edge path are directed from the source node towards the target node without ever changing their direction back towards the source node.

If an unknown restriction is specified, MonotonicPathRestriction.NONE will be used instead.

Default Value:

The default value is MonotonicPathRestriction.NONE. No path restrictions are used.

Parameters:

value - one of the predefined monotonic path restrictions

See Also:

getMonotonicPathRestriction()

setPenaltySettings

public void setPenaltySettings(PenaltySettings value)

Sets the PenaltySettings used for this edge.

Besides specifying a completely customized setting, the user can choose between four predefined optimization strategies: PenaltySettings.OPTIMIZATION_BALANCED, PenaltySettings.OPTIMIZATION_EDGE_BENDS, PenaltySettings.OPTIMIZATION_EDGE_CROSSINGS and PenaltySettings.OPTIMIZATION_EDGE_LENGTHS.

Throws:

IllegalArgumentException - if the given penalty settings are null

Parameters:

value - the penalty settings used for this edge

See Also:

PenaltySettings.OPTIMIZATION_BALANCED, PenaltySettings.OPTIMIZATION_EDGE_BENDS, PenaltySettings.OPTIMIZATION_EDGE_CROSSINGS, PenaltySettings.OPTIMIZATION_EDGE_LENGTHS, getPenaltySettings()