TriangulationDSFace

java.lang.Object
- Jcg.triangulations2D.TriangulationDSFace_2<X>

All Implemented Interfaces:

java.lang.Comparable<TriangulationDSFace_2<X>>
```
public class TriangulationDSFace_2<X extends Point_>
extends java.lang.Object
implements java.lang.Comparable<TriangulationDSFace_2<X>>
```
The class used to encode a face of a triangulation. Each cell stores pointers to its three vertices as well as to its four neighboring faces. The vertices and neighbors are indexed 0, 1, and 2. Neighbor i lies opposite to vertex i. By convention, edge i is the intersection of the face and of neighbor i, therefore it also lies opposite to vertex i.

Author:

Luca Castelli Aleardi and Steve Oudot

Field Summary

Fields
Modifier and Type Field and Description

int index

int tag

Fields
Modifier and Type	Field and Description
`int`	`index`
`int`	`tag`

Constructor Summary

Constructors
Constructor and Description
`TriangulationDSFace_2()` creates an empty cell, whose vertices and neighbors need to be specified later.
`TriangulationDSFace_2(TriangulationDSVertex_2<X> v0, TriangulationDSVertex_2<X> v1, TriangulationDSVertex_2<X> v2, TriangulationDSFace_2<X> c0, TriangulationDSFace_2<X> c1, TriangulationDSFace_2<X> c2)` creates a face with vertices v0 through v2 and with neighbors c0 through c2.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(TriangulationDSFace_2<X> f)` compares the face to another face using a clockwise order on their vertices
`boolean`	`hasGeometricNeighbor(TriangulationDSFace_2<X> c)` checks whether c is geometrically a neighbor of the face, that is, whether the two triangles share a common edge.
`boolean`	`hasNeighbor(TriangulationDSFace_2<X> c)` checks whether c is a neighbor of the face.
`boolean`	`hasVertex(TriangulationDSVertex_2<X> v)` checks whether v is a vertex of the cell.
`boolean`	`hasVertex(X x)` checks whether x is a point associated with a vertex of the face.
`int`	`index(TriangulationDSFace_2<X> c)` returns the index of the neighboring face c, and throws an Error if c is no neighbor of the face.
`int`	`index(TriangulationDSVertex_2<X> v)` returns the index of vertex v in the cell, and throws an Error if v is no vertex of the cell.
`int`	`index(X x)` returns the index of the vertex of the face associated with x, and throws an Error if x is associated with no vertex of the face.
`void`	`invertMark(int index)` inverts the mark of the index-th edge
`boolean`	`isMarked(int index)` returns the mark of the index-th edge
`void`	`mark(int index)` sets the mark of the index-th edge
`TriangulationDSFace_2<X>`	`neighbor(int i)` returns a pointer to the i-th neighbor of the cell (0<=i<3), which is by definition the one opposite to the i-th vertex of the cell.
`void`	`setNeighbor(int i, TriangulationDSFace_2<X> c)` sets the i-th neighbor of the cell to be c (0<=i<3).
`void`	`setVertex(int i, TriangulationDSVertex_2<X> v)` sets the i-th vertex of the cell to be v (0<=i<3).
`java.lang.String`	`toString()` generates a string listing the coordinates of the vertices of the face.
`void`	`unmark(int index)` unsets the mark of the index-th edge
`TriangulationDSVertex_2<X>`	`vertex(int i)` returns a pointer to the i-th vertex of the triangle (0<=i<3).
`Point_[]`	`verticesPoints()` returns an array containing the geometric points associated with the vertices of the triangle

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - tag
```
public int tag
```
  - index
```
public int index
```
- Constructor Detail
  - TriangulationDSFace_2
```
public TriangulationDSFace_2()
```
    creates an empty cell, whose vertices and neighbors need to be specified later.
  - TriangulationDSFace_2
```
public TriangulationDSFace_2(TriangulationDSVertex_2<X> v0,
                             TriangulationDSVertex_2<X> v1,
                             TriangulationDSVertex_2<X> v2,
                             TriangulationDSFace_2<X> c0,
                             TriangulationDSFace_2<X> c1,
                             TriangulationDSFace_2<X> c2)
```
    creates a face with vertices v0 through v2 and with neighbors c0 through c2. Each ci is opposite to vi.
- Method Detail
  - vertex
```
public TriangulationDSVertex_2<X> vertex(int i)
```
    returns a pointer to the i-th vertex of the triangle (0<=i<3).
  - verticesPoints
```
public Point_[] verticesPoints()
```
    returns an array containing the geometric points associated with the vertices of the triangle
  - neighbor
```
public TriangulationDSFace_2<X> neighbor(int i)
```
    returns a pointer to the i-th neighbor of the cell (0<=i<3), which is by definition the one opposite to the i-th vertex of the cell.
  - setVertex
```
public void setVertex(int i,
                      TriangulationDSVertex_2<X> v)
```
    sets the i-th vertex of the cell to be v (0<=i<3).
  - setNeighbor
```
public void setNeighbor(int i,
                        TriangulationDSFace_2<X> c)
```
    sets the i-th neighbor of the cell to be c (0<=i<3).
  - index
```
public int index(TriangulationDSVertex_2<X> v)
```
    returns the index of vertex v in the cell, and throws an Error if v is no vertex of the cell.
  - index
```
public int index(TriangulationDSFace_2<X> c)
```
    returns the index of the neighboring face c, and throws an Error if c is no neighbor of the face.
  - hasVertex
```
public boolean hasVertex(TriangulationDSVertex_2<X> v)
```
    checks whether v is a vertex of the cell.
  - hasVertex
```
public boolean hasVertex(X x)
```
    checks whether x is a point associated with a vertex of the face.
  - index
```
public int index(X x)
```
    returns the index of the vertex of the face associated with x, and throws an Error if x is associated with no vertex of the face.
  - hasNeighbor
```
public boolean hasNeighbor(TriangulationDSFace_2<X> c)
```
    checks whether c is a neighbor of the face.
  - hasGeometricNeighbor
```
public boolean hasGeometricNeighbor(TriangulationDSFace_2<X> c)
```
    checks whether c is geometrically a neighbor of the face, that is, whether the two triangles share a common edge.
  - toString
```
public java.lang.String toString()
```
    generates a string listing the coordinates of the vertices of the face.
    
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(TriangulationDSFace_2<X> f)
```
    compares the face to another face using a clockwise order on their vertices
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<TriangulationDSFace_2<X extends Point_>>
  - isMarked
```
public boolean isMarked(int index)
```
    returns the mark of the index-th edge
  - mark
```
public void mark(int index)
```
    sets the mark of the index-th edge
  - unmark
```
public void unmark(int index)
```
    unsets the mark of the index-th edge
  - invertMark
```
public void invertMark(int index)
```
    inverts the mark of the index-th edge

Class TriangulationDSFace_2<X extends Point_>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tag

index

Constructor Detail

TriangulationDSFace_2

TriangulationDSFace_2

Method Detail

vertex

verticesPoints

neighbor

setVertex

setNeighbor

index

index

hasVertex

hasVertex

index

hasNeighbor

hasGeometricNeighbor

toString

compareTo

isMarked

mark

unmark

invertMark