com.yworks.yfiles.layout.router.polyline

Interface IObstaclePartition

All Superinterfaces:

IPartition

All Known Implementing Classes:

DynamicObstacleDecomposition

public interface IObstaclePartition
extends IPartition

This class implements a IPartition that takes a list of Obstacles as input to subdivide an area into PartitionCells.

Implementations have to satisfy the following condition for each pair of Obstacle and PartitionCell:

• Obstacles either completely cover PartitionCells or do not intersect PartitionCells at all.

Example of an IObstaclePartition of a graph consisting of two nodes connected by one edge. The two nodes are considered to be obstacles. The colored partition cells subdivide the area such that each obstacle either completely covers a partition cell or does not intersect with a partition cell.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the partition data such that the IObstaclePartition can be reused and initialized with new Obstacles.
List<Object>	getCells(Obstacle obstacle) Returns all PartitionCells that are completely covered by the given Obstacle.
List<Object>	getObstacles(PartitionCell cell) Returns all Obstacles that cover the given PartitionCell.
void	init(List<Object> obstacles, YRectangle bounds) Initializes a new IObstaclePartition of the area with the given bounds using the given list of Obstacles.

Methods inherited from interface com.yworks.yfiles.layout.router.polyline.IPartition

getBounds, getCells, getNeighbors

Method Detail

clear

void clear()

Clears the partition data such that the IObstaclePartition can be reused and initialized with new Obstacles.

See Also:

init(List, YRectangle)

getCells

List<Object> getCells(Obstacle obstacle)

Returns all PartitionCells that are completely covered by the given Obstacle.

Parameters:

obstacle - the obstacle for which the covered cells will be returned

Returns:

an unmodifiable list of PartitionCell instances that are completely covered by the given obstacle

getObstacles

List<Object> getObstacles(PartitionCell cell)

Returns all Obstacles that cover the given PartitionCell.

Parameters:

cell - the partition cell for which the obstacles will be returned

Returns:

an unmodifiable list of Obstacle instances that cover the given cell

init

void init(List<Object> obstacles,
          YRectangle bounds)

Initializes a new IObstaclePartition of the area with the given bounds using the given list of Obstacles.

Unused partitions must be cleared using method clear().

Parameters:

obstacles - a list of Obstacles that have to be considered by the partition

bounds - the bounds of the partition

See Also:

clear()