com.yworks.yfiles.view

Class GraphObstacleProvider

java.lang.Object

com.yworks.yfiles.view.GraphObstacleProvider

All Implemented Interfaces:

IObstacleProvider

public class GraphObstacleProvider
extends Object
implements IObstacleProvider

An implementation of the IObstacleProvider interface that uses the edges and nodes of an IGraph as obstacles.

The BridgeManager then calculates bridges for edge paths that cross these obstacles.

This class can be used to add bridge support via the BridgeManager to a rendered IGraph.

See Also:

BridgeManager.addObstacleProvider(IObstacleProvider), BridgeManager, IObstacleProvider

Constructor Summary

Constructors

Constructor and Description
GraphObstacleProvider()

Method Summary

Modifier and Type	Method and Description
protected IGraph	getGraph(IRenderContext context) Helper method that retrieves the IGraph to use from the .
GeneralPath	getObstacles(IRenderContext context) Iterates over all Edges and Nodes to query an IObstacleProvider from the IModelItem's ILookup.lookup(java.lang.Class).
boolean	isEdgeQueryingEnabled() Gets a value indicating whether to query the Edges for an IObstacleProvider implementation.
boolean	isNodeQueryingEnabled() Gets a value indicating whether to query the Nodes for an IObstacleProvider implementation.
void	setEdgeQueryingEnabled(boolean value) Sets a value indicating whether to query the Edges for an IObstacleProvider implementation.
void	setNodeQueryingEnabled(boolean value) Sets a value indicating whether to query the Nodes for an IObstacleProvider implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphObstacleProvider

public GraphObstacleProvider()

Method Detail

getGraph

protected IGraph getGraph(IRenderContext context)

Helper method that retrieves the IGraph to use from the .context

This implementation uses the ILookup.lookup(java.lang.Class) of the CanvasControl to query the IGraph implementation.

Parameters:

context - The context to retrieve the implementation from.

Returns:

The IGraph instance to query or null.

getObstacles

public GeneralPath getObstacles(IRenderContext context)

Iterates over all Edges and Nodes to query an IObstacleProvider from the IModelItem's ILookup.lookup(java.lang.Class).

This method will depending on the EdgeQueryingEnabled and NodeQueryingEnabled property query the items for an implementation of IObstacleProvider and concatenate all resulting GeneralPath obstacles into one path that will then be returned.

Specified by:

getObstacles in interface IObstacleProvider

Parameters:

context - The context where the obstacles are queried for.

Returns:

A path that is the concatenated path of all obstacles for the given context.

isEdgeQueryingEnabled

public final boolean isEdgeQueryingEnabled()

Gets a value indicating whether to query the Edges for an IObstacleProvider implementation.

The default is true.

Returns:

The EdgeQueryingEnabled.

See Also:

setEdgeQueryingEnabled(boolean)

isNodeQueryingEnabled

public final boolean isNodeQueryingEnabled()

Gets a value indicating whether to query the Nodes for an IObstacleProvider implementation.

Returns:

true if nodes should be queried at all; false otherwise. The default is false.

See Also:

setNodeQueryingEnabled(boolean)

setEdgeQueryingEnabled

public final void setEdgeQueryingEnabled(boolean value)

Sets a value indicating whether to query the Edges for an IObstacleProvider implementation.

The default is true.

Parameters:

value - The EdgeQueryingEnabled to set.

See Also:

isEdgeQueryingEnabled()

setNodeQueryingEnabled

public final void setNodeQueryingEnabled(boolean value)

Sets a value indicating whether to query the Nodes for an IObstacleProvider implementation.

Parameters:

value - true if nodes should be queried at all; false otherwise. The default is false.

See Also:

isNodeQueryingEnabled()