Regina Calculation Engine
Public Member Functions | List of all members
regina::NFaceEmbedding Class Reference

Details how a face in the skeleton forms part of an individual tetrahedron. More...

#include <triangulation/nface.h>

Public Member Functions

 NFaceEmbedding (NTetrahedron *newTet, int newFace)
 Creates an embedding descriptor containing the given data. More...
 
 NFaceEmbedding (const NFaceEmbedding &cloneMe)
 Creates an embedding descriptor containing the same data as the given embedding descriptor. More...
 
NTetrahedrongetTetrahedron () const
 Returns the tetrahedron in which this face is contained. More...
 
int getFace () const
 Returns the face number within getTetrahedron() that is this face. More...
 
NPerm4 getVertices () const
 Returns a mapping from vertices (0,1,2) of this face to the corresponding vertex numbers in getTetrahedron(), as described in NTetrahedron::getFaceMapping(). More...
 

Detailed Description

Details how a face in the skeleton forms part of an individual tetrahedron.

Constructor & Destructor Documentation

regina::NFaceEmbedding::NFaceEmbedding ( NTetrahedron newTet,
int  newFace 
)
inline

Creates an embedding descriptor containing the given data.

Parameters
newTetthe tetrahedron in which this face is contained.
newFacethe face number of newTet that is this face.
regina::NFaceEmbedding::NFaceEmbedding ( const NFaceEmbedding cloneMe)
inline

Creates an embedding descriptor containing the same data as the given embedding descriptor.

Parameters
cloneMethe embedding descriptor to clone.

Member Function Documentation

int regina::NFaceEmbedding::getFace ( ) const
inline

Returns the face number within getTetrahedron() that is this face.

Returns
the face number that is this face.
NTetrahedron * regina::NFaceEmbedding::getTetrahedron ( ) const
inline

Returns the tetrahedron in which this face is contained.

Returns
the tetrahedron.
NPerm4 regina::NFaceEmbedding::getVertices ( ) const
inline

Returns a mapping from vertices (0,1,2) of this face to the corresponding vertex numbers in getTetrahedron(), as described in NTetrahedron::getFaceMapping().

Returns
a mapping from the vertices of this face to the vertices of getTetrahedron().

The documentation for this class was generated from the following file:

Copyright © 1999-2012, The Regina development team
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).