PathSearchExtension

The given EdgeCellInfo describes how the partition cell that has been entered by the current entrance would be traversed if this enter interval to the neighboring cell would be chosen.

The maxAllowedCosts describe the maximum costs that entering the neighboring cell via the given enter interval may induce. If the maximum cost is exceeded, calculations that may further increase its cost may be skipped because this interval won't be chosen anyway.

This implementation doesn't add any costs. It may be overridden to add costs, e.g., if entering through the given interval would create a bend.

After evaluating the costs for each enter interval to a neighboring cell, this method is called for each of the resulting CellEntrances.

This implementation doesn't add any costs. It may be overridden to add some heuristic costs, e.g., if the edge would have to bend to reach the target node from the given CellEntrance.

This method is called for each start entrance of the current edge.

The current implementation doesn't add any costs for the given CellEntrance. It may be overridden to make start entrances with less specific intervals more expensive. For example, intervals that allow more than just the LayoutPortCandidate location to connect to the source node become more expensive.

This callback notifies the extension when the path search for the current edge is canceled. Then, the path search will proceed with altering the penalties of the current edge and reinitializing it again.

This implementation does nothing. It may be overridden to reset some edge specific information, e.g., removing previously added listeners.

This callback notifies the extension when the path search for the current request is canceled. In case that not all requests of an edge are successful, then also the path search for that edge will be canceled.

This implementation does nothing. It may be overridden to process or reset PathSearchRequest-specific data like e.g., previously registered listeners.

This callback notifies the extension when enough paths are found for the current edge. After that, the path search either proceeds with initializing the next current edge in the context's edge list or calls finalizeEdges if all edges in this list have been handled.

This implementation does nothing. It may be overridden to add/reset some edge-specific information, e.g., removing previously added listeners or adding new start entrances.

If the path search is configured to calculate several possible paths for an edge, the path search proceeds with choosing another unhandled CellEntrance.

This implementation does nothing. It may be overridden to collect some information about the given path that may influence the path search of later edges.

This method is called for each edge of the context. Each call will be balanced by a call to either finalizeCurrentEdge or cancelCurrentEdge.

It may be overridden to initialize/reset the settings for the current edge (e.g. minimum distances).

This method is called for each request of the context's currentEdge. Each call will be balanced by a call to either finalizePath or cancelCurrentPathRequest.

This method may be overridden to modify settings and data that should be individual for each PathSearchRequest.

This method may be called several times during a path search. Each call will be balanced by calls to finalizeEdges. The default implementation stores the given context in property context.

It may be overridden to initialize/reset the settings for the routed edges (e.g. minimum distances).

Each time a CellEntrance is chosen as the next step, all registered extensions are asked if this entrance is a valid target entrance. Only if none of the extensions returns false, a PathSearchResult is created.

This implementation accepts all CellEntrances as valid targets. It may be overridden to only activate the target if the route fulfills a certain condition.