com.yworks.yfiles.layout

Class EdgeBundleDescriptor

java.lang.Object

com.yworks.yfiles.layout.EdgeBundleDescriptor

public class EdgeBundleDescriptor
extends Object

An EdgeBundleDescriptor defines the bundling settings of an edge.

The defined settings will be considered by layout algorithms which support edge bundling.

Each EdgeBundleDescriptor can either be specified for a single edge or shared by several edges. It is assigned to an edge by registering a IDataProvider with key EdgeBundling.EDGE_BUNDLE_DESCRIPTOR_DPKEY to the input graph.

See Also:

EdgeBundling, EdgeBundling.EDGE_BUNDLE_DESCRIPTOR_DPKEY

Constructor Summary

Constructors

Constructor and Description
EdgeBundleDescriptor() Creates a new EdgeBundleDescriptor with default settings.
EdgeBundleDescriptor(EdgeBundleDescriptor descriptor) Creates a new EdgeBundleDescriptor representing a copy of the given other descriptor instance.

Method Summary

Modifier and Type	Method and Description
boolean	isBezierFittingEnabled() Gets whether or not a bezier curve should be fit to an edge associated to this descriptor.
boolean	isBundled() Gets whether or not an edge associated to this descriptor should be bundled.
boolean	isDirectionConsiderationEnabled() Gets whether or not the direction of the edge associated to this descriptor should be considered.
void	setBezierFittingEnabled(boolean value) Sets whether or not a bezier curve should be fit to an edge associated to this descriptor.
void	setBundled(boolean value) Sets whether or not an edge associated to this descriptor should be bundled.
void	setDirectionConsiderationEnabled(boolean value) Sets whether or not the direction of the edge associated to this descriptor should be considered.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeBundleDescriptor

public EdgeBundleDescriptor()

Creates a new EdgeBundleDescriptor with default settings.

EdgeBundleDescriptor

public EdgeBundleDescriptor(EdgeBundleDescriptor descriptor)

Creates a new EdgeBundleDescriptor representing a copy of the given other descriptor instance.

Parameters:

descriptor - the descriptor to copy

Method Detail

isBezierFittingEnabled

public boolean isBezierFittingEnabled()

Gets whether or not a bezier curve should be fit to an edge associated to this descriptor.

If disabled, the edges resemble B-splines where points of the path are actually curve points. Therefore, this representation requires a high number of bends to model curves.

If this feature is enabled, a bezier curve is fitted to the start and end point as well as the intermediate control points of the edge. After the fitting, the points of the edge can be interpreted as cubic bezier control points. Each four consecutive points form a bezier curve, where the first and last of the four points represent the start and end of the curve and the second and third point are the control points defining how the curve looks. The second and third point do not necessarily lie on the actual curve.

Enabling bezier fitting will likely reduce the number of bend points necessary to model the curved edge path significantly.

When visualizing a fitted edge, the control points should not simply be connected by straight-line segments. This may lead to bad results, i.e., wrong paths. The points need to be interpreted as cubic bezier control points as described above.

Default Value:

The default value is false. Edges resemble B-splines

Returns:

true if a bezier curve is fitted to an edge associated with this descriptor, false otherwise

See Also:

setBezierFittingEnabled(boolean)

isBundled

public boolean isBundled()

Gets whether or not an edge associated to this descriptor should be bundled.

If an edge should not be bundled, the other settings of this descriptor will be ignored.

Default Value:

The default value is false. Bundling is disabled.

Returns:

true if an edge associated to this descriptor is bundled, false otherwise

See Also:

setBundled(boolean)

isDirectionConsiderationEnabled

public boolean isDirectionConsiderationEnabled()

Gets whether or not the direction of the edge associated to this descriptor should be considered.

During the bundling procedure, the edges are bundled based on their direction such that the incoming edges of a node are bundled separately from its outgoing edges. If the direction of edges adjacent to a node is not considered, then they are not bundled separately.

If the direction of some edges is taken into consideration while the direction of some others (adjacent to the same node) is ignored, the undirected edges are also bundled separately. This is done to distinguished them from the incoming and outgoing edges of the particular node.

Default Value:

The default value is true. The direction of the edge is considered.

Returns:

true if the direction of the edge is considered, false otherwise

See Also:

setDirectionConsiderationEnabled(boolean)

setBezierFittingEnabled

public void setBezierFittingEnabled(boolean value)

Sets whether or not a bezier curve should be fit to an edge associated to this descriptor.

If disabled, the edges resemble B-splines where points of the path are actually curve points. Therefore, this representation requires a high number of bends to model curves.

If this feature is enabled, a bezier curve is fitted to the start and end point as well as the intermediate control points of the edge. After the fitting, the points of the edge can be interpreted as cubic bezier control points. Each four consecutive points form a bezier curve, where the first and last of the four points represent the start and end of the curve and the second and third point are the control points defining how the curve looks. The second and third point do not necessarily lie on the actual curve.

Enabling bezier fitting will likely reduce the number of bend points necessary to model the curved edge path significantly.

When visualizing a fitted edge, the control points should not simply be connected by straight-line segments. This may lead to bad results, i.e., wrong paths. The points need to be interpreted as cubic bezier control points as described above.

Default Value:

The default value is false. Edges resemble B-splines

Parameters:

value - true if a bezier curve is fitted to an edge associated with this descriptor, false otherwise

See Also:

isBezierFittingEnabled()

setBundled

public void setBundled(boolean value)

Sets whether or not an edge associated to this descriptor should be bundled.

If an edge should not be bundled, the other settings of this descriptor will be ignored.

Default Value:

The default value is false. Bundling is disabled.

Parameters:

value - true if an edge associated to this descriptor is bundled, false otherwise

See Also:

isBundled()

setDirectionConsiderationEnabled

public void setDirectionConsiderationEnabled(boolean value)

Sets whether or not the direction of the edge associated to this descriptor should be considered.

During the bundling procedure, the edges are bundled based on their direction such that the incoming edges of a node are bundled separately from its outgoing edges. If the direction of edges adjacent to a node is not considered, then they are not bundled separately.

If the direction of some edges is taken into consideration while the direction of some others (adjacent to the same node) is ignored, the undirected edges are also bundled separately. This is done to distinguished them from the incoming and outgoing edges of the particular node.

Default Value:

The default value is true. The direction of the edge is considered.

Parameters:

value - true if the direction of the edge is considered, false otherwise

See Also:

isDirectionConsiderationEnabled()