regina::NFaceEmbedding Class Reference
[Triangulations]

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

#include <nface.h>

List of all members.

Public Member Functions
	NFaceEmbedding (NTetrahedron *newTet, int newFace)
	Creates an embedding descriptor containing the given data.
	NFaceEmbedding (const NFaceEmbedding &cloneMe)
	Creates an embedding descriptor containing the same data as the given embedding descriptor.
NTetrahedron *	getTetrahedron () const
	Returns the tetrahedron in which this face is contained.
int	getFace () const
	Returns the face number within getTetrahedron() that is this face.
NPerm	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().

---

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:

	newTet	the tetrahedron in which this face is contained.
	newFace	the 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:

cloneMe

the embedding descriptor to clone.

---

Member Function Documentation

NTetrahedron * regina::NFaceEmbedding::getTetrahedron

(

)

const [inline]

Returns the tetrahedron in which this face is contained.

Returns:

the tetrahedron.

int regina::NFaceEmbedding::getFace

(

)

const [inline]

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

Returns:

the face number that is this face.

NPerm 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:

• nface.h