com.yworks.yfiles.layout.router.polyline

Class PathSearchContext

java.lang.Object

com.yworks.yfiles.layout.router.polyline.PathSearchContext

public class PathSearchContext
extends Object

This class provides context information that is useful for the PathSearch algorithm.

Most notably, the context provides access to the edge that is currently being routed (see CurrentEdge).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathSearchContext(PathSearch pathSearch, PathSearchConfiguration configuration) Creates a new instance of PathSearchContext.

Method Summary

Modifier and Type	Method and Description
void	addSourceCell(PartitionCell cell) Adds an additional source cell of the current edge if it is not already contained in the list of source cells.
void	addTargetCell(PartitionCell cell) Adds an additional target cell of the current edge if it is not already contained in the list of target cells.
PartitionCell	getCombinedSourceCell() Gets an artificial partition cell with the size of the bounding box of all source cells of the current edge.
PartitionCell	getCombinedTargetCell() Gets an artificial partition cell with the size of the bounding box of all target cells of the current edge.
PathSearchConfiguration	getConfiguration() Gets the configuration used for the PathSearch.
Edge	getCurrentEdge() Gets the edge that is currently routed.
EdgeLayoutDescriptor	getCurrentEdgeLayoutDescriptor() Gets the EdgeLayoutDescriptor for the current edge containing edge specific settings for the path search.
IEdgeCursor	getEdges() Gets the IEdgeCursor to iterate over the edges that are routed.
PathSearch	getPathSearch() Gets the PathSearch that uses this context.
PathSearchResult	getPathSearchResult() Gets the results of the PathSearch.
PartitionCell	getSourceCell(int index) Returns the source cell with the given index in the list of all cells that are covered by the source node of the current edge.
PartitionCell	getTargetCell(int index) Returns the target cell with the given index in the list of all cells that are covered by the target node of the current edge.
boolean	isSourceCell(PartitionCell cell) Determines whether or not the given cell is a source cell of the current edge.
boolean	isTargetCell(PartitionCell cell) Determines whether or not the given cell is a target cell of the current edge.
protected void	setCurrentEdge(Edge value) Sets the edge that is currently routed.
protected void	setEdges(EdgeList edges) Specifies the edges that shall be routed.
int	sourceCellCount() Returns the number of all cells that are covered by the source node of the current edge.
int	targetCellCount() Returns the number of all cells that are covered by the target node of the current edge.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathSearchContext

protected PathSearchContext(PathSearch pathSearch,
                            PathSearchConfiguration configuration)

Creates a new instance of PathSearchContext.

Parameters:

pathSearch - the path search that uses this context

configuration - the configuration used for the path search

Method Detail

addSourceCell

public void addSourceCell(PartitionCell cell)

Adds an additional source cell of the current edge if it is not already contained in the list of source cells.

Parameters:

cell - the new source cell to add

See Also:

sourceCellCount(), getSourceCell(int)

addTargetCell

public void addTargetCell(PartitionCell cell)

Adds an additional target cell of the current edge if it is not already contained in the list of target cells.

Parameters:

cell - the new target cell to add

See Also:

targetCellCount(), getTargetCell(int)

getCombinedSourceCell

public PartitionCell getCombinedSourceCell()

Gets an artificial partition cell with the size of the bounding box of all source cells of the current edge.

Returns:

an artificial partition cell with the size of the bounding box of all source cells

See Also:

getSourceCell(int)

getCombinedTargetCell

public PartitionCell getCombinedTargetCell()

Gets an artificial partition cell with the size of the bounding box of all target cells of the current edge.

Returns:

an artificial partition cell with the size of the bounding box of all target cells

See Also:

getTargetCell(int)

getConfiguration

public PathSearchConfiguration getConfiguration()

Gets the configuration used for the PathSearch.

Returns:

the configuration used for the path search

getCurrentEdge

public Edge getCurrentEdge()

Gets the edge that is currently routed.

This edge is one of those returned by Edges.

Returns:

the edge that is currently routed

getCurrentEdgeLayoutDescriptor

public EdgeLayoutDescriptor getCurrentEdgeLayoutDescriptor()

Gets the EdgeLayoutDescriptor for the current edge containing edge specific settings for the path search.

Returns:

the descriptor for the current edge

getEdges

public IEdgeCursor getEdges()

Gets the IEdgeCursor to iterate over the edges that are routed.

Returns:

the IEdgeCursor to iterate over the edges for which a path is calculated

getPathSearch

public PathSearch getPathSearch()

Gets the PathSearch that uses this context.

Returns:

the path search that uses this context

getPathSearchResult

public PathSearchResult getPathSearchResult()

Gets the results of the PathSearch.

Returns:

the results of the path search

getSourceCell

public PartitionCell getSourceCell(int index)

Returns the source cell with the given index in the list of all cells that are covered by the source node of the current edge.

Parameters:

index - the index of the source cell

Returns:

the source cell with the given index in the list of all source cells

getTargetCell

public PartitionCell getTargetCell(int index)

Returns the target cell with the given index in the list of all cells that are covered by the target node of the current edge.

Parameters:

index - the index of the target cell

Returns:

the target cell with the given index in the list of all cells that are covered by the target node of the current edge

isSourceCell

public boolean isSourceCell(PartitionCell cell)

Determines whether or not the given cell is a source cell of the current edge.

Parameters:

cell - the cell

Returns:

true if the given cell is in the list of source cells, false otherwise

See Also:

sourceCellCount(), getSourceCell(int)

isTargetCell

public boolean isTargetCell(PartitionCell cell)

Determines whether or not the given cell is a target cell of the current edge.

Parameters:

cell - the cell

Returns:

true if the given cell is in the list of target cells, false otherwise

See Also:

targetCellCount(), getTargetCell(int)

setCurrentEdge

protected void setCurrentEdge(Edge value)

Sets the edge that is currently routed.

This edge is one of those returned by Edges.

Parameters:

value - the edge that is currently routed

See Also:

getCurrentEdge()

setEdges

protected void setEdges(EdgeList edges)

Specifies the edges that shall be routed.

Parameters:

edges - the list of edges that shall be routed

sourceCellCount

public int sourceCellCount()

Returns the number of all cells that are covered by the source node of the current edge.

Returns:

the number of all cells that are covered by the source node

targetCellCount

public int targetCellCount()

Returns the number of all cells that are covered by the target node of the current edge.

Returns:

the number of all cells that are covered by the target node