C

GraphObstacleProvider

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

Remarks

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

Developer's Guide

API

addObstacleProvider, BridgeManager, IObstacleProvider

Members

Show:

Properties

queryEdges

: boolean
Gets or sets a value indicating whether to query the edges for an IObstacleProvider implementation.
The default is true.
final

queryNodes

: boolean
Gets or sets a value indicating whether to query the nodes for an IObstacleProvider implementation.
final

Property Value

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

See Also

Developer's Guide

Methods

getGraph

(context: IRenderContext): IGraph
protected
Helper method that retrieves the IGraph to use from the context
This implementation uses the lookup of the canvasComponent to query the IGraph implementation.
protected

Parameters

context: IRenderContext
The context to retrieve the implementation from.

Return Value

IGraph
The IGraph instance to query or null.

getObstacles

(context: IRenderContext): GeneralPath
Iterates over all edges and nodes to query an IObstacleProvider from the IModelItem's lookup.
This method will depend on the queryEdges and queryNodes property to query the items for an implementation of IObstacleProvider and concatenate all resulting GeneralPath obstacles into one path that will then be returned.

Parameters

context: IRenderContext
The context where the obstacles are queried for.

Return Value

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