Search this API

y.layout.router
Class ChannelEdgeRouter.OrthogonalShortestPathPathFinder

java.lang.Object
  extended by y.layout.AbstractLayoutStage
      extended by y.layout.router.OrthogonalEdgeRouter
          extended by y.layout.router.ChannelEdgeRouter.OrthogonalShortestPathPathFinder
All Implemented Interfaces:
Layouter, LayoutStage
Enclosing class:
ChannelEdgeRouter

public static class ChannelEdgeRouter.OrthogonalShortestPathPathFinder
extends OrthogonalEdgeRouter

This layouter is a s special version of OrthogonalEdgeRouter that can be used as a path finding strategy in ChannelEdgeRouter. It takes a bit longer than using the default path finding strategy OrthogonalPatternEdgeRouter but therefore will create no node crossings. It can be configured like OrthogonalEdgeRouter.


Field Summary
 
Fields inherited from class y.layout.router.OrthogonalEdgeRouter
MONOTONIC_BOTH, MONOTONIC_HORIZONTAL, MONOTONIC_NONE, MONOTONIC_VERTICAL, ROUTE_ALL_EDGES, ROUTE_EDGES_AT_SELECTED_NODES, ROUTE_SELECTED_EDGES, STYLE_ADHOC, STYLE_BALANCED, STYLE_PREFERMIDDLE, STYLE_SHORTPATH
 
Fields inherited from interface y.layout.Layouter
EDGE_ID_DPKEY, NODE_ID_DPKEY, SELECTED_EDGES, SELECTED_NODES
 
Constructor Summary
ChannelEdgeRouter.OrthogonalShortestPathPathFinder()
           
 
Method Summary
 boolean canLayout(LayoutGraph graph)
          Returns true if the specified core layouter does, and also when there is no core layouter.
 void doLayout(LayoutGraph graph)
          Main entrance to orthogonal edge routing.
 Object getAffectedEdgesDPKey()
          Returns the key of a DataProvider that defines the edges, that shall be affected
 void setAffectedEdgesDPKey(Object key)
          Determines a key, that is registered on the graph and determines the edges which shall be affected by this router.
 
Methods inherited from class y.layout.router.OrthogonalEdgeRouter
checkGroupNodeSize, checkNodeSize, getBadOrthogonal, getCenterToSpaceRatio, getCoupledDistances, getCrossingCost, getCustomBorderCapacity, getCustomBorderCapacityEnabled, getGridOrigin, getGridSpacing, getMinimumDistance, getMinimumDistanceToNode, getMonotonicPathRestriction, getRoutingStyle, getSelectedEdgesDpKey, getSelectedNodesDpKey, getSphereOfAction, isConsiderNodeLabelsEnabled, isEnforceMonotonicPathRestrictions, isGridRoutingEnabled, isInnerPortsEnabled, isLocalCrossingMinimizationEnabled, isReroutingEnabled, setBadOrthogonal, setCenterToSpaceRatio, setConsiderNodeLabelsEnabled, setCoupledDistances, setCrossingCost, setCustomBorderCapacity, setCustomBorderCapacityEnabled, setEnforceMonotonicPathRestrictions, setGridOrigin, setGridRoutingEnabled, setGridSpacing, setInnerPortsEnabled, setLocalCrossingMinimizationEnabled, setMinimumDistance, setMinimumDistanceToNode, setMonotonicPathRestriction, setReroutingEnabled, setRoutingStyle, setSelectedEdgesDpKey, setSelectedNodesDpKey, setSphereOfAction
 
Methods inherited from class y.layout.AbstractLayoutStage
canLayoutCore, doLayoutCore, getCoreLayouter, setCoreLayouter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChannelEdgeRouter.OrthogonalShortestPathPathFinder

public ChannelEdgeRouter.OrthogonalShortestPathPathFinder()
Method Detail

canLayout

public boolean canLayout(LayoutGraph graph)
Description copied from class: OrthogonalEdgeRouter
Returns true if the specified core layouter does, and also when there is no core layouter.

Specified by:
canLayout in interface Layouter
Overrides:
canLayout in class OrthogonalEdgeRouter

doLayout

public void doLayout(LayoutGraph graph)
Description copied from class: OrthogonalEdgeRouter
Main entrance to orthogonal edge routing. Routes the edges of the given graph.

Specified by:
doLayout in interface Layouter
Overrides:
doLayout in class OrthogonalEdgeRouter

setAffectedEdgesDPKey

public void setAffectedEdgesDPKey(Object key)
Determines a key, that is registered on the graph and determines the edges which shall be affected by this router.

Parameters:
key - the key of a DataProvider that defines the edges, that shall be affected

getAffectedEdgesDPKey

public Object getAffectedEdgesDPKey()
Returns the key of a DataProvider that defines the edges, that shall be affected

Returns:
the key of a DataProvider that defines the edges, that shall be affected

© Copyright 2000-2013,
yWorks GmbH.
All rights reserved.