com.yworks.yfiles.layout.router.polyline

Class CellEntrance

java.lang.Object

com.yworks.yfiles.layout.router.polyline.CellEntrance

public class CellEntrance
extends Object

This class describes the location and the direction from which a given partition cell has been entered during a path search.

The path that was followed in order to reach a given partition cell can be reconstructed by traversing all previous entrances. The enter interval and enter direction determine how the partition cell was entered.

Constructor Summary

Constructors

Constructor and Description
CellEntrance(CellEntrance other) Creates a new CellEntrance instance that is a copy of a given other CellEntrance.
CellEntrance(PartitionCell cell) Creates a new CellEntrance instance for a given PartitionCell.

Method Summary

Modifier and Type	Method and Description
PartitionCell	getCell() Gets the partition cell of this CellEntrance instance.
double	getCosts() Gets the costs for the implicit path given by the previous entrances.
Direction	getEnterDirection() Gets the direction from which this cell was entered.
OrthogonalInterval	getEnterInterval() Gets the OrthogonalInterval that was used for entering this cell.
double	getHeuristicCosts() Gets the heuristic costs for the implicit path given by the previous entrances.
EdgeCellInfo	getPreviousEdgeCellInfo() Gets the EdgeCellInfo describing how the previous partition cell was traversed.
CellEntrance	getPreviousEntrance() Gets the previous CellEntrance along the path that was traversed in order to reach the cell.
void	setCosts(double value) Sets the costs for the implicit path given by the previous entrances.
void	setEnterDirection(Direction value) Sets the direction from which this cell was entered.
void	setEnterInterval(OrthogonalInterval value) Sets the OrthogonalInterval that was used for entering this cell.
void	setHeuristicCosts(double value) Sets the heuristic costs for the implicit path given by the previous entrances.
void	setPreviousEdgeCellInfo(EdgeCellInfo value) Sets the EdgeCellInfo describing how the previous partition cell was traversed.
void	setPreviousEntrance(CellEntrance value) Sets the previous CellEntrance along the path that was traversed in order to reach the cell.
String	toString() Returns a string representation of this CellEntrance.

Methods inherited from class java.lang.Object

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

Constructor Detail

CellEntrance

public CellEntrance(CellEntrance other)

Creates a new CellEntrance instance that is a copy of a given other CellEntrance.

Parameters:

other - the CellEntrance to be copied

CellEntrance

public CellEntrance(PartitionCell cell)

Creates a new CellEntrance instance for a given PartitionCell.

Parameters:

cell - the PartitionCell that is entered

Method Detail

getCell

public PartitionCell getCell()

Gets the partition cell of this CellEntrance instance.

Returns:

the partition cell of this CellEntrance instance

getCosts

public double getCosts()

Gets the costs for the implicit path given by the previous entrances.

The costs must be non-negative.

Throws:

IllegalArgumentException - if the costs are negative

Default Value:

The default value is 0.

Returns:

the costs for the implicit path given by the previous entrances

See Also:

setCosts(double)

getEnterDirection

public Direction getEnterDirection()

Gets the direction from which this cell was entered.

Returns:

the direction from which this cell was entered or null if this cell is a start entrance

See Also:

setEnterDirection(Direction)

getEnterInterval

public OrthogonalInterval getEnterInterval()

Gets the OrthogonalInterval that was used for entering this cell.

Returns:

the OrthogonalInterval used for entering this cell or null if it is a start entrance

See Also:

setEnterInterval(OrthogonalInterval)

getHeuristicCosts

public double getHeuristicCosts()

Gets the heuristic costs for the implicit path given by the previous entrances.

Heuristic costs must be non-negative.

Throws:

IllegalArgumentException - if the heuristic costs are negative

Default Value:

The default value is 0.

Returns:

the heuristic costs for the implicit path given by the previous entrances

See Also:

setHeuristicCosts(double)

getPreviousEdgeCellInfo

public EdgeCellInfo getPreviousEdgeCellInfo()

Gets the EdgeCellInfo describing how the previous partition cell was traversed.

Returns:

the EdgeCellInfo describing how the previous cell was traversed or null if this cell is a start entrance

See Also:

setPreviousEdgeCellInfo(EdgeCellInfo)

getPreviousEntrance

public CellEntrance getPreviousEntrance()

Gets the previous CellEntrance along the path that was traversed in order to reach the cell.

Returns:

the previous CellEntrance or null if this cell is a start entrance

See Also:

setPreviousEntrance(CellEntrance)

setCosts

public void setCosts(double value)

Sets the costs for the implicit path given by the previous entrances.

The costs must be non-negative.

Throws:

IllegalArgumentException - if the costs are negative

Default Value:

The default value is 0.

Parameters:

value - the costs for the implicit path given by the previous entrances

See Also:

getCosts()

setEnterDirection

public void setEnterDirection(Direction value)

Sets the direction from which this cell was entered.

Parameters:

value - the direction from which this cell was entered or null if this cell is a start entrance

See Also:

getEnterDirection()

setEnterInterval

public void setEnterInterval(OrthogonalInterval value)

Sets the OrthogonalInterval that was used for entering this cell.

Parameters:

value - the OrthogonalInterval used for entering this cell or null if it is a start entrance

See Also:

getEnterInterval()

setHeuristicCosts

public void setHeuristicCosts(double value)

Sets the heuristic costs for the implicit path given by the previous entrances.

Heuristic costs must be non-negative.

Throws:

IllegalArgumentException - if the heuristic costs are negative

Default Value:

The default value is 0.

Parameters:

value - the heuristic costs for the implicit path given by the previous entrances

See Also:

getHeuristicCosts()

setPreviousEdgeCellInfo

public void setPreviousEdgeCellInfo(EdgeCellInfo value)

Sets the EdgeCellInfo describing how the previous partition cell was traversed.

Parameters:

value - the EdgeCellInfo describing how the previous cell was traversed or null if this cell is a start entrance

See Also:

getPreviousEdgeCellInfo()

setPreviousEntrance

public void setPreviousEntrance(CellEntrance value)

Sets the previous CellEntrance along the path that was traversed in order to reach the cell.

Parameters:

value - the previous CellEntrance or null if this cell is a start entrance

See Also:

getPreviousEntrance()

toString

public String toString()

Returns a string representation of this CellEntrance.

Overrides:

toString in class Object

Returns:

a string representation of this CellEntrance