TAPsHEHalfEdge.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsHEHalfEdge.hpp

HE <==> Half-Edge
HEHalfEdge class is a class for 3D half-edge.
It contains:
  - originating vertex
  - incident face
  - pair of this half-edge
  - next half-edge (CCW)
  - previous half-edge (CW)

Not supposed to be a parent class.
Support only manifold objects.

SUKITTI PUNAK   (04/03/2005)
UPDATE          (10/26/2010)
******************************************************************************/
#ifndef TAPs_HE_HALF_EDGE_HPP
#define TAPs_HE_HALF_EDGE_HPP

#include "../../Core/TAPsLib.hpp"

template <typename T> class HEVertex;
template <typename T> class HEFace;

BEGIN_NAMESPACE_TAPs
//=============================================================================
template <typename T>
class HEHalfEdge {
//=============================================================================
// DATA MEMBERS
//=============================================================================
protected:
    HEVertex<T>   *nOrigVertex;     // originated from vertex
    HEFace<T>     *nIncidentFace;   // incident face -- the face that contains this half-edge
    HEHalfEdge<T> *nPrev;           // previous half-edge (cw direction) 
    HEHalfEdge<T> *nNext;           // next     half-edge (ccw direction)
    HEHalfEdge<T> *nPair;           // twin or pair of this half-edge
    // in a doubly circular linked list
//=============================================================================
// MEMBER FUNCTIONS
//=============================================================================
public:
    //-------------------------------------------------------------------------
    // Output Operator <<
    friend std::ostream & operator<< ( std::ostream &output, 
                                       HEHalfEdge<T> const &he )
    {
        output  << "HEHalfEdge: address " << &he
                << ", orig vertex "     << (he.nOrigVertex)
                << ", incident face "   << (he.nIncidentFace)
                << ", previous "        << (he.nPrev)
                << ", next "            << (he.nNext)
                << ", pair "            << (he.nPair);
        return output;
    }
    //-------------------------------------------------------------------------
    // Constructor(s) and Destructor
    HEHalfEdge ( HEVertex<T>   * const nOrigVertex   = NULL, 
                 HEFace<T>     * const nIncidentFace = NULL,
                 HEHalfEdge<T> * const nPrev         = NULL,
                 HEHalfEdge<T> * const nNext         = NULL,
                 HEHalfEdge<T> * const nPair         = NULL );
    HEHalfEdge ( HEHalfEdge<T> const &he ); // copy ctor
    virtual ~HEHalfEdge ();                 // destructor
    //-------------------------------------------------------------------------
    // Get/Set Fn(s)

    inline void Vertex ( HEVertex<T> * const ptrOrigVertex )    { nOrigVertex = ptrOrigVertex; }
    inline HEVertex<T> * Vertex () const    { return nOrigVertex; }
    inline void Face ( HEFace<T> * const ptrIncidentFace )  { nIncidentFace = ptrIncidentFace; }
    inline HEFace<T> * Face () const    { return nIncidentFace; }
    inline void Pair ( HEHalfEdge<T> * const pair ) { nPair = pair; }
    inline HEHalfEdge<T> * Pair () const    { return nPair; }

    //-------------------------------------------------------------------------
    // Operations

    inline HEHalfEdge<T> * Prev () const { return nPrev; }
    inline HEHalfEdge<T> * Next () const { return nNext; }
    inline void Prev ( HEHalfEdge<T> * const v ) { nPrev = v; }
    inline void Next ( HEHalfEdge<T> * const v ) { nNext = v; }

    // Since HalfEdge comes in pair, 
    // so we disable insert, remove, delete, and splice
    /*
    HEHalfEdge<T> * Insert ( HEHalfEdge<T> * const n );
    HEHalfEdge<T> * Remove ();
    inline void     Delete ();
    HEHalfEdge<T> * Splice ( HEHalfEdge<T> * const n );
    void ClearExceptItself ();
    //*/

    //-------------------------------------------------------------------------
}; // END CLASS HEHalfEdge
//=============================================================================
END_NAMESPACE_TAPs
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
//#if !defined( TAPs_USE_EXPORT )
    #include "TAPsHEHalfEdge.cpp"
//#endif
//-----------------------------------------------------------------------------
#endif
//345678901234567890123456789012345678901234567890123456789012345678901234567890
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8