com.yworks.yfiles.layout.hierarchic

Class DefaultDrawingDistanceCalculator

java.lang.Object

com.yworks.yfiles.layout.hierarchic.DefaultDrawingDistanceCalculator

All Implemented Interfaces:

IDrawingDistanceCalculator

public class DefaultDrawingDistanceCalculator
extends Object
implements IDrawingDistanceCalculator

This class is a default IDrawingDistanceCalculator implementation that is used by HierarchicLayoutCore to configure the INodePlacer.

Constructor Summary

Constructors

Constructor and Description
DefaultDrawingDistanceCalculator() Creates a new instance of DefaultDrawingDistanceCalculator with default settings.

Method Summary

Modifier and Type	Method and Description
void	dispose(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Disposes of internal data structures.
double	getEdgeToEdgeDistance() Gets the minimum distance between two edges.
double	getMinDistance(LayoutGraph graph, ILayer layer, ILayoutDataProvider ldp, Node left, Node right) Determines the minimum distance between two Nodes of the same layer.
double	getNodeToEdgeDistance() Gets the minimum distance between a Node and an (non-adjacent) Edge.
double	getNodeToNodeDistance() Gets the minimum distance between two Nodes.
void	initialize(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Initializes internal data structures.
boolean	isAdaptiveMinimumEdgeDistanceEnabled() Gets whether or not an adaptive minimum edge distance is used.
boolean	isCompactionEnabled() Gets whether or not the compaction option is enabled.
boolean	isSwimlaneDistanceOptimizationEnabled() Gets whether or not to use an optimized minimum distance calculation for swimlane layouts.
void	setAdaptiveMinimumEdgeDistanceEnabled(boolean value) Sets whether or not an adaptive minimum edge distance is used.
void	setCompactionEnabled(boolean value) Sets whether or not the compaction option is enabled.
void	setEdgeToEdgeDistance(double value) Sets the minimum distance between two edges.
void	setNodeToEdgeDistance(double value) Sets the minimum distance between a Node and an (non-adjacent) Edge.
void	setNodeToNodeDistance(double value) Sets the minimum distance between two Nodes.
void	setSwimlaneDistanceOptimizationEnabled(boolean value) Sets whether or not to use an optimized minimum distance calculation for swimlane layouts.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDrawingDistanceCalculator

public DefaultDrawingDistanceCalculator()

Creates a new instance of DefaultDrawingDistanceCalculator with default settings.

Method Detail

dispose

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

Description copied from interface: IDrawingDistanceCalculator

Disposes of internal data structures.

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

Specified by:

dispose in interface IDrawingDistanceCalculator

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:

IDrawingDistanceCalculator.initialize(LayoutGraph, ILayers, ILayoutDataProvider)

getEdgeToEdgeDistance

public double getEdgeToEdgeDistance()

Gets the minimum distance between two edges.

Minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum distance is negative

Default Value:

The default value is 20.0d.

Returns:

the given minimum distance

See Also:

setEdgeToEdgeDistance(double)

getMinDistance

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

Determines the minimum distance between two Nodes of the same layer.

Specified by:

getMinDistance in interface IDrawingDistanceCalculator

Parameters:

graph - the input graph

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

ldp - the ILayoutDataProvider used for querying information

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 distances between Nodes of same layer

getNodeToEdgeDistance

public double getNodeToEdgeDistance()

Gets the minimum distance between a Node and an (non-adjacent) Edge.

Minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum distance is negative

Default Value:

The default value is 15.0d.

Returns:

the minimum distance

See Also:

setNodeToEdgeDistance(double)

getNodeToNodeDistance

public double getNodeToNodeDistance()

Gets the minimum distance between two Nodes.

Minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum distance is negative

Default Value:

The default value is 30.0d.

Returns:

the minimum distance

See Also:

setNodeToNodeDistance(double)

initialize

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

Description copied from interface: IDrawingDistanceCalculator

Initializes internal data structures.

Implementations may cache lengthy calculations in the initialization phase.

Specified by:

initialize in interface IDrawingDistanceCalculator

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:

IDrawingDistanceCalculator.dispose(LayoutGraph, ILayers, ILayoutDataProvider)

isAdaptiveMinimumEdgeDistanceEnabled

public boolean isAdaptiveMinimumEdgeDistanceEnabled()

Gets whether or not an adaptive minimum edge distance is used.

If this option is enabled the minimum distance between two adjacent edges is the minimum of the current minimum edge distance and the distance of the edges' source/target points.

Default Value:

The default value is true. An adaptive minimum distance is used.

Returns:

true if an adaptive minimum distance should be used, false otherwise

See Also:

setAdaptiveMinimumEdgeDistanceEnabled(boolean)

isCompactionEnabled

public boolean isCompactionEnabled()

Gets whether or not the compaction option is enabled.

This option is automatically set by the layout algorithm if option NodeCompaction or LabelCompactionEnabled is enabled.

Default Value:

The default value is false. Compaction is disabled.

Returns:

true if compaction is enabled, false otherwise

See Also:

setCompactionEnabled(boolean)

isSwimlaneDistanceOptimizationEnabled

public boolean isSwimlaneDistanceOptimizationEnabled()

Gets whether or not to use an optimized minimum distance calculation for swimlane layouts.

If set to true this instance will report 0.0d as the minimum distance between two nodes if they belong to different swimlanes. This avoids unwanted feedback between different swimlanes during node placement.

Default Value:

The default value is false.

Returns:

true if modified distance calculation for swimlane layouts should be used, false otherwise

See Also:

setSwimlaneDistanceOptimizationEnabled(boolean)

setAdaptiveMinimumEdgeDistanceEnabled

public void setAdaptiveMinimumEdgeDistanceEnabled(boolean value)

Sets whether or not an adaptive minimum edge distance is used.

If this option is enabled the minimum distance between two adjacent edges is the minimum of the current minimum edge distance and the distance of the edges' source/target points.

Default Value:

The default value is true. An adaptive minimum distance is used.

Parameters:

value - true if an adaptive minimum distance should be used, false otherwise

See Also:

isAdaptiveMinimumEdgeDistanceEnabled()

setCompactionEnabled

public void setCompactionEnabled(boolean value)

Sets whether or not the compaction option is enabled.

This option is automatically set by the layout algorithm if option NodeCompaction or LabelCompactionEnabled is enabled.

Default Value:

The default value is false. Compaction is disabled.

Parameters:

value - true if compaction is enabled, false otherwise

See Also:

isCompactionEnabled()

setEdgeToEdgeDistance

public void setEdgeToEdgeDistance(double value)

Sets the minimum distance between two edges.

Minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum distance is negative

Default Value:

The default value is 20.0d.

Parameters:

value - the given minimum distance

See Also:

getEdgeToEdgeDistance()

setNodeToEdgeDistance

public void setNodeToEdgeDistance(double value)

Sets the minimum distance between a Node and an (non-adjacent) Edge.

Minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum distance is negative

Default Value:

The default value is 15.0d.

Parameters:

value - the minimum distance

See Also:

getNodeToEdgeDistance()

setNodeToNodeDistance

public void setNodeToNodeDistance(double value)

Sets the minimum distance between two Nodes.

Minimum distance should be greater than 0.

Throws:

IllegalArgumentException - if the minimum distance is negative

Default Value:

The default value is 30.0d.

Parameters:

value - the minimum distance

See Also:

getNodeToNodeDistance()

setSwimlaneDistanceOptimizationEnabled

public void setSwimlaneDistanceOptimizationEnabled(boolean value)

Sets whether or not to use an optimized minimum distance calculation for swimlane layouts.

If set to true this instance will report 0.0d as the minimum distance between two nodes if they belong to different swimlanes. This avoids unwanted feedback between different swimlanes during node placement.

Default Value:

The default value is false.

Parameters:

value - true if modified distance calculation for swimlane layouts should be used, false otherwise

See Also:

isSwimlaneDistanceOptimizationEnabled()