Search this API

y.layout.planar
Class CombinatorialEmbedder

java.lang.Object
  extended by y.layout.planar.CombinatorialEmbedder
All Implemented Interfaces:
y.layout.orthogonal.general.MaximumDurationAware, Embedder

public class CombinatorialEmbedder
extends java.lang.Object
implements Embedder, y.layout.orthogonal.general.MaximumDurationAware

Interface implementation for an embedder.

 

Field Summary
static short DFS_TREE
           
static short GT
           
 
Constructor Summary
CombinatorialEmbedder()
           
 
Method Summary
 void dispose()
          Undoes the changes in the graph and removes the complete help info
 void embed()
          This method does the whole embedding work
 long getMaximumDuration()
           
protected  InitialPlanarSubgraph getPlanarSubgraphInstance(short _subgraphType)
          Returns an instance of which a planar subgraph.
 int getPlanarSubgraphRandomizationIterations()
          Returns the number of iterations used by the planar subgraph algorithm.
 int getRerouteIterations()
          Returns the number of iterations over the list of all split edges.
 boolean getUseBiconnectedComponents()
          Returns indicator for usage of bccs is allowed or not resp.
 boolean getUseEdgeRerouting()
          Returns indicator for edge re-routing is allowed or not resp.
 boolean getUseFaceMaximization()
          Returns if the usage of a face maximizer is wanted or not.
 boolean getUseRandomization()
          Returns whether randomization is used or not.
 void setMaximumDuration(long maximumDuration)
           
 void setPlanarInformation(PlanarInformation planar)
          Sets the planar information which will contain the embedding.
 void setPlanarSubgraphRandomizationIterations(int planarSubgraphRandomizationIterations)
          Sets the number of iterations used by the planar subgraph algorithm.
 void setRerouteIterations(int i)
          Sets the number of iterations over the list of all split edges
 void setUseBiconnectedComponents(boolean b)
          Sets indicator for usage of bccs is allowed or not resp.
 void setUseEdgeRerouting(boolean b)
          Sets indicator for edge re-routing is allowed or not resp.
 void setUseFaceMaximization(boolean b)
          Sets indicator if the usage of a face maximizer is wanted or not.
 void setUseRandomization(boolean b)
          Sets whether randomization is used or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GT

public static final short GT
See Also:
Constant Field Values

DFS_TREE

public static final short DFS_TREE
See Also:
Constant Field Values
Constructor Detail

CombinatorialEmbedder

public CombinatorialEmbedder()
Method Detail

setPlanarInformation

public void setPlanarInformation(PlanarInformation planar)
Sets the planar information which will contain the embedding.

Specified by:
setPlanarInformation in interface Embedder
Parameters:
planar - a PlanarInformation object

getMaximumDuration

public long getMaximumDuration()

setMaximumDuration

public void setMaximumDuration(long maximumDuration)
Specified by:
setMaximumDuration in interface y.layout.orthogonal.general.MaximumDurationAware

setUseEdgeRerouting

public void setUseEdgeRerouting(boolean b)
Sets indicator for edge re-routing is allowed or not resp. is wanted or not.

Parameters:
b - true if edge re-routing is wanted, else false

getUseEdgeRerouting

public boolean getUseEdgeRerouting()
Returns indicator for edge re-routing is allowed or not resp. is wanted or not.


setUseBiconnectedComponents

public void setUseBiconnectedComponents(boolean b)
Sets indicator for usage of bccs is allowed or not resp. is wanted or not.

Parameters:
b - true if bcc usage is wanted, else false

getUseBiconnectedComponents

public boolean getUseBiconnectedComponents()
Returns indicator for usage of bccs is allowed or not resp. is wanted or not.

Returns:
true if bcc usage is wanted, else false

setUseFaceMaximization

public void setUseFaceMaximization(boolean b)
Sets indicator if the usage of a face maximizer is wanted or not.

Parameters:
b - true if one face of the embedding should be maximized, else false

getUseFaceMaximization

public boolean getUseFaceMaximization()
Returns if the usage of a face maximizer is wanted or not.

Returns:
true if one face of the embedding should be maximized, else false

setRerouteIterations

public void setRerouteIterations(int i)
Sets the number of iterations over the list of all split edges

Parameters:
i - the number of iterations

getRerouteIterations

public int getRerouteIterations()
Returns the number of iterations over the list of all split edges.

Returns:
the number of iterations

setUseRandomization

public void setUseRandomization(boolean b)
Sets whether randomization is used or not.

Parameters:
b - true if randomization is wanted, else false

getUseRandomization

public boolean getUseRandomization()
Returns whether randomization is used or not.

Returns:
true if randomization is wanted, else false

getPlanarSubgraphRandomizationIterations

public int getPlanarSubgraphRandomizationIterations()
Returns the number of iterations used by the planar subgraph algorithm. Only considered when randomization is activated.


setPlanarSubgraphRandomizationIterations

public void setPlanarSubgraphRandomizationIterations(int planarSubgraphRandomizationIterations)
Sets the number of iterations used by the planar subgraph algorithm. Only considered when randomization is activated.

Parameters:
planarSubgraphRandomizationIterations - positive number.

embed

public void embed()
This method does the whole embedding work

Specified by:
embed in interface Embedder

dispose

public void dispose()
Undoes the changes in the graph and removes the complete help info

Specified by:
dispose in interface Embedder

getPlanarSubgraphInstance

protected InitialPlanarSubgraph getPlanarSubgraphInstance(short _subgraphType)
Returns an instance of which a planar subgraph.

Parameters:
_subgraphType - specifies the technique used to find a planar subgraph
Returns:
an instance of InitialPlanarSubgraph

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