com.yworks.yfiles.algorithms

Class PlanarEmbedding

java.lang.Object

com.yworks.yfiles.algorithms.PlanarEmbedding

public final class PlanarEmbedding
extends Object

Represents an embedding of a planar graph.

A planar embedding is represented by a list of faces. Each face is represented by a list of darts which describe the border of the face.

Querying the planar embedding after changes to the underlying graph structure may produce exceptions.

Constructor Summary

Constructors

Constructor and Description
PlanarEmbedding(Graph graph) Creates a new embedding for the specified planar graph.

Method Summary

Modifier and Type	Method and Description
Dart	getCyclicNext(Dart dart) Returns the cyclic next dart of the given dart.
Dart	getCyclicPrevious(Dart dart) Returns the cyclic previous dart of the given dart.
Dart[]	getDarts(Edge edge) Returns the two darts associated with the given edge.
List<List<Dart>>	getFaces() Gets a List of face lists.
List<Dart>	getOuterFace() Gets the List that represents the outer face.
List<Dart>	getOutgoingDarts(Node node) Returns a List containing the (cyclic ordered) outgoing darts of the specified node.
static boolean	isPlanar(Graph graph) Return whether or not the given graph is planar.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanarEmbedding

public PlanarEmbedding(Graph graph)

Creates a new embedding for the specified planar graph.

Throws:

IllegalArgumentException - if the specified graph is not planar

Parameters:

graph - a planar graph

Method Detail

getCyclicNext

public final Dart getCyclicNext(Dart dart)

Returns the cyclic next dart of the given dart.

Parameters:

dart - a dart

Returns:

the cyclic next dart of the given dart

getCyclicPrevious

public final Dart getCyclicPrevious(Dart dart)

Returns the cyclic previous dart of the given dart.

Parameters:

dart - a dart

Returns:

the cyclic previous dart of the given dart

getDarts

public final Dart[] getDarts(Edge edge)

Returns the two darts associated with the given edge.

Parameters:

edge - an edge

Returns:

the two darts associated with the given edge

getFaces

public final List<List<Dart>> getFaces()

Gets a List of face lists.

More precisely, each entry of this list is another list that contains all darts of a face.

Returns:

a List of face lists.

getOuterFace

public final List<Dart> getOuterFace()

Gets the List that represents the outer face.

The returned list is also contained in the face lists.

Returns:

the List that represents the outer face

See Also:

getFaces()

getOutgoingDarts

public final List<Dart> getOutgoingDarts(Node node)

Returns a List containing the (cyclic ordered) outgoing darts of the specified node.

Parameters:

node - a node

Returns:

a List containing the (cyclic ordered) outgoing darts

isPlanar

public static final boolean isPlanar(Graph graph)

Return whether or not the given graph is planar.

Parameters:

graph - the input graph

Returns:

true if the given graph is planar, false otherwise