Geom Software - C++ Programming and Geometry Libraries
Fade3D Documentation pages v0.99
FADE3D::Edge3 Class Reference

Edge of a tetrahedron. More...

#include <Edge3.h>

Public Member Functions

 Edge3 (Tet3 *pTet_, const int opp3_, const int opp2_)
 Constructor of Edge3. More...
 
Tet3getTet () const
 Get the tetrahedron.
 
int getOpp3Index () const
 Get the opp3ITI index.
 
int getOpp2Index () const
 Get the opp2ITI index.
 
int getSourceIndex () const
 Get the source index. More...
 
int getTargetIndex () const
 Get the target index. More...
 
Point3getSourceVtx () const
 Get the source vertex of the edge.
 
Point3getTargetVtx () const
 Get the target vertex of the edge.
 
bool operator== (const Edge3 &rhs) const
 Check if two undirected edges coincide. More...
 
bool operator!= (const Edge3 &rhs) const
 Check if two undirected edges are different. More...
 

Friends

std::ostream & operator<< (std::ostream &stream, Edge3 &e)
 

Detailed Description

An Edge3 is represented by a Tet3 pointer and two two IntraTetIndices opp3 and opp2. The Edge of the tetrahedron is selected as follows: At first, opp3 selects the facet (triangle) of the tetrahedron opposite to the corner addressed by opp3. Then opp2 selects the edge in this triangle opposite to the vertex at position opp2. See the image where opp3=3 and opp2=0. The edge proceeds from corner 1 to corner 2.

Edge3.png
Edge (0,1) of a tetrahedron, selected by opp3=3 and opp2=0

Constructor & Destructor Documentation

◆ Edge3()

FADE3D::Edge3::Edge3 ( Tet3 pTet_,
const int  opp3_,
const int  opp2_ 
)
Parameters
pTet_Tetrahedron
opp3_selects one of the four triangles of the tetrahedron
opp2_selects one of the edges of the triangle

Member Function Documentation

◆ getSourceIndex()

int FADE3D::Edge3::getSourceIndex ( ) const
Returns
the index of the tetrahedron which selects the source vertex of the edge

◆ getTargetIndex()

int FADE3D::Edge3::getTargetIndex ( ) const
Returns
the index of the tetrahedron which selects the target vertex of the edge

◆ operator!=()

bool FADE3D::Edge3::operator!= ( const Edge3 rhs) const

Two Edge3 objects are different when they do not refer to the same undirected edge.

◆ operator==()

bool FADE3D::Edge3::operator== ( const Edge3 rhs) const

Two edges are equal when their vertices coincide (undirected edge) even if the two objects use different tetrahedra that meet on this edge.


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