Regina Calculation Engine
|
Represents a component of the boundary of a 2-manifold triangulation. More...
#include <dim2/dim2boundarycomponent.h>
Public Member Functions | |
virtual | ~Dim2BoundaryComponent () |
Default destructor. More... | |
unsigned long | index () const |
Returns the index of this boundary component in the underlying triangulation. More... | |
unsigned long | getNumberOfEdges () const |
Returns the number of edges in this boundary component. More... | |
unsigned long | getNumberOfVertices () const |
Returns the number of vertices in this boundary component. More... | |
Dim2Edge * | getEdge (unsigned long index) const |
Returns the requested edge in this boundary component. More... | |
Dim2Vertex * | getVertex (unsigned long index) const |
Returns the requested vertex in this boundary component. More... | |
Dim2Component * | getComponent () const |
Returns the component of the triangulation to which this boundary component belongs. More... | |
void | writeTextShort (std::ostream &out) const |
Writes this object in short text format to the given output stream. More... | |
void | writeTextLong (std::ostream &out) const |
Writes this object in long text format to the given output stream. More... | |
long | markedIndex () const |
Returns the index at which this object is stored in an NMarkedVector. More... | |
Input and Output | |
std::string | str () const |
Returns the output from writeTextShort() as a string. More... | |
std::string | toString () const |
A deprecated alias for str(), which returns the output from writeTextShort() as a string. More... | |
std::string | detail () const |
Returns the output from writeTextLong() as a string. More... | |
std::string | toStringLong () const |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string. More... | |
Friends | |
class | Dim2Triangulation |
Allow access to private members. More... | |
Represents a component of the boundary of a 2-manifold triangulation.
Boundary components are highly temporary; once a triangulation changes, all its boundary component objects will be deleted and new ones will be created.
|
inlinevirtual |
Default destructor.
|
inherited |
Returns the output from writeTextLong() as a string.
|
inline |
Returns the component of the triangulation to which this boundary component belongs.
|
inline |
Returns the requested edge in this boundary component.
The index of a Dim2Edge in the boundary component need not be the index of the same edge in the entire 2-manifold triangulation.
index | the index of the requested edge in the boundary component. This should be between 0 and getNumberOfEdges()-1 inclusive. |
|
inline |
Returns the number of edges in this boundary component.
|
inline |
Returns the number of vertices in this boundary component.
|
inline |
Returns the requested vertex in this boundary component.
The index of a Dim2Vertex in the boundary component need not be the index of the same vertex in the entire 2-manifold triangulation.
index | the index of the requested vertex in the boundary component. This should be between 0 and getNumberOfVertices()-1 inclusive. |
|
inline |
Returns the index of this boundary component in the underlying triangulation.
This is identical to calling getTriangulation()->boundaryComponentIndex(this)
.
|
inlineinherited |
Returns the index at which this object is stored in an NMarkedVector.
If this object does not belong to an NMarkedVector, the return value is undefined.
|
inherited |
Returns the output from writeTextShort() as a string.
__str__()
function.
|
inlineinherited |
A deprecated alias for str(), which returns the output from writeTextShort() as a string.
|
inlineinherited |
A deprecated alias for detail(), which returns the output from writeTextLong() as a string.
|
virtual |
Writes this object in long text format to the given output stream.
The output should provide the user with all the information they could want. The output should be human-readable, should not contain extremely long lines (so users can read the output in a terminal), and should end with a final newline.
The default implementation of this routine merely calls writeTextShort() and adds a newline.
out | the output stream to which to write. |
Reimplemented from regina::ShareableObject.
|
inlinevirtual |
Writes this object in short text format to the given output stream.
The output should be human-readable, should fit on a single line, and should not end with a newline.
out | the output stream to which to write. |
Implements regina::ShareableObject.
|
friend |
Allow access to private members.