C

PlanarEmbedding
expert

Show Usages
Represents an embedding of a planar graph.
Inheritance Hierarchy

Remarks

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.

Members

No filters for this type

Constructors

PlanarEmbedding

(graph: LayoutGraph)
Creates a new embedding for the specified planar graph.

Parameters

graph: LayoutGraph
A planar graph

Throws

Exception ({ name: 'ArgumentError' })
If the specified graph is not planar

Properties

faces

: IList<IList<Dart>>
readonly
Gets an IList<T> of face lists.
More precisely, each entry of this list is another list that contains all Darts of a face.
readonlyfinal

Property Value

an IList<T> of face lists.

outerFace

: IList<Dart>
readonly
Gets the IList<T> that represents the outer face.
The returned list is also contained in the face lists.
readonlyfinal

Property Value

The IList<T> that represents the outer face.

See Also

API
faces

Methods

getCyclicNext

(dart: Dart): Dart
Returns the cyclic next dart of the given dart.
final

Parameters

dart: Dart
a dart

Return Value

Dart
the cyclic next dart of the given dart

getCyclicPrevious

(dart: Dart): Dart
Returns the cyclic previous dart of the given dart.
final

Parameters

dart: Dart
a dart

Return Value

Dart
the cyclic previous dart of the given dart

getDarts

(edge: LayoutEdge): Dart[]
Returns the two darts associated with the given edge.
final

Parameters

edge: LayoutEdge
an edge

Return Value

Dart[]
the two darts associated with the given edge

getOutgoingDarts

(node: LayoutNode): IList<Dart>
Returns a IList<T> containing the (cyclic ordered) outgoing darts of the specified node.
final

Parameters

node: LayoutNode
A node

Return Value

IList<Dart>
An IList<T> containing the (cyclic ordered) outgoing darts

Static Methods

isPlanar

(graph: LayoutGraph): boolean
static
Return whether or not the given graph is planar.
static

Parameters

graph: LayoutGraph
the input graph

Return Value

boolean
true if the given graph is planar, false otherwise