#include <nboundarycomponent.h>
Public Member Functions | |
NBoundaryComponent () | |
Default constructor. | |
NBoundaryComponent (NVertex *idealVertex) | |
Creates a new boundary component consisting only of the given ideal vertex. | |
virtual | ~NBoundaryComponent () |
Default destructor. | |
unsigned long | getNumberOfFaces () const |
Returns the number of faces in this boundary component. | |
unsigned long | getNumberOfEdges () const |
Returns the number of edges in this boundary component. | |
unsigned long | getNumberOfVertices () const |
Returns the number of vertices in this boundary component. | |
NFace * | getFace (unsigned long index) const |
Returns the requested face in this boundary component. | |
NEdge * | getEdge (unsigned long index) const |
Returns the requested edge in this boundary component. | |
NVertex * | getVertex (unsigned long index) const |
Returns the requested vertex in this boundary component. | |
long | getEulerCharacteristic () const |
Returns the Euler characteristic of this boundary component. | |
bool | isIdeal () const |
Determines if this boundary component is ideal. | |
bool | isOrientable () const |
Determines if this boundary component is orientable. | |
void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. | |
Friends | |
class | NTriangulation |
Allow access to private members. |
Note that an ideal vertex constitutes a boundary component of its own.
If a vertex link is a multiply punctured surface, the corresponding boundary components meeting the vertex will not necessarily be considered a single boundary component. The vertex in question will be placed in all boundary components concerned, although only one of these boundary components can be considered the "official" boundary component of the vertex as returned by NVertex::getBoundaryComponent(). Note that a triangulation containing such a vertex is invalid.
Boundary components are highly temporary; once a triangulation changes, all its boundary component objects will be deleted and new ones will be created.
regina::NBoundaryComponent::NBoundaryComponent | ( | ) | [inline] |
Default constructor.
regina::NBoundaryComponent::NBoundaryComponent | ( | NVertex * | idealVertex | ) | [inline] |
Creates a new boundary component consisting only of the given ideal vertex.
idealVertex | the vertex to place in the new boundary component. |
regina::NBoundaryComponent::~NBoundaryComponent | ( | ) | [inline, virtual] |
Default destructor.
unsigned long regina::NBoundaryComponent::getNumberOfFaces | ( | ) | const [inline] |
Returns the number of faces in this boundary component.
unsigned long regina::NBoundaryComponent::getNumberOfEdges | ( | ) | const [inline] |
Returns the number of edges in this boundary component.
unsigned long regina::NBoundaryComponent::getNumberOfVertices | ( | ) | const [inline] |
Returns the number of vertices in this boundary component.
NFace * regina::NBoundaryComponent::getFace | ( | unsigned long | index | ) | const [inline] |
Returns the requested face in this boundary component.
index | the index of the requested face in the boundary component. This should be between 0 and getNumberOfFaces()-1 inclusive. Note that the index of a face in the boundary component need not be the index of the same face in the entire triangulation. |
NEdge * regina::NBoundaryComponent::getEdge | ( | unsigned long | index | ) | const [inline] |
Returns the requested edge in this boundary component.
index | the index of the requested edge in the boundary component. This should be between 0 and getNumberOfEdges()-1 inclusive. Note that the index of a edge in the boundary component need not be the index of the same edge in the entire triangulation. |
NVertex * regina::NBoundaryComponent::getVertex | ( | unsigned long | index | ) | const [inline] |
Returns the requested vertex in this boundary component.
index | the index of the requested vertex in the boundary component. This should be between 0 and getNumberOfVertices()-1 inclusive. Note that the index of a vertex in the boundary component need not be the index of the same vertex in the entire triangulation. |
long regina::NBoundaryComponent::getEulerCharacteristic | ( | ) | const [inline] |
Returns the Euler characteristic of this boundary component.
If this boundary component is ideal, the Euler characteristic of the link of the corresponding ideal vertex is returned.
bool regina::NBoundaryComponent::isIdeal | ( | ) | const [inline] |
Determines if this boundary component is ideal.
This is the case if and only if it consists of a single (ideal) vertex and no faces.
true
if and only if this boundary component is ideal. bool regina::NBoundaryComponent::isOrientable | ( | ) | const [inline] |
Determines if this boundary component is orientable.
If the boundary component is ideal, the orientability of the link of the corresponding ideal vertex is returned.
true
if and only if this boundary component is orientable. void regina::NBoundaryComponent::writeTextShort | ( | std::ostream & | out | ) | const [inline, virtual] |
Writes this object in short text format to the given output stream.
The output should fit on a single line and no newline should be written.
out | the output stream to which to write. |
Implements regina::ShareableObject.
friend class NTriangulation [friend] |
Allow access to private members.