TAPsHEFace.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsHEFace.hpp

HE <==> Half-Edge
HEFace class is a class for 3D half-edge Face.
It contains:
  - normal
  - vertex loop
  - texture coordinates for the vertex loop
  - incident half-edge
It should contain a set of pointers to its vertices in CCW order.
Example:
           2-------1
            \       \
             \       \
              \       0
               \     /
                \   /
                 \ /
                  3

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

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

#include <vector>
#include "../../Core/TAPsLib.hpp"

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

BEGIN_NAMESPACE_TAPs
//=============================================================================
template <typename T>
class HEFace {
//=============================================================================
protected:
    Vector3<T>      m_vNormal;              
    HEHalfEdge<T>  *nIncidentHalfEdge;      
    HEFace<T> *nPrev;   
    HEFace<T> *nNext;   

#ifdef  TAPs_SUPPORT_ASE_FORMAT
    unsigned char   m_iSubmatID;            
#endif//TAPs_SUPPORT_ASE_FORMAT

#ifdef  TAPs_ENABLE_FACE_VERTEX_COLOR
    std::vector<int> m_sviVertexColorList;  
#endif//TAPs_ENABLE_FACE_VERTEX_COLOR

#ifdef  TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
    std::vector<int> m_sviVertexTextureList;    
#else //TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
    std::vector<T>  m_2DTexCoordsVector;        
#endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES

//=============================================================================
public:
    //-------------------------------------------------------------------------
    // Output Operator <<
    friend std::ostream & operator<< ( std::ostream &output, HEFace<T> const &f )
    {
        output  << "HEFace<" << typeid(T).name() << "> has ";
//              << f.m_ptrVertexLoopVector.size() << " vertices:";
        //------------------------------------------------------------
        // Output vertex loop
//      for ( int i = 0; i < f.m_ptrVertexLoopVector.size(); ++i )
//      {
//          output << "  " << *(f.m_ptrVertexLoopVector[i]);
//      }
        //------------------------------------------------------------
        // Output normal
        output << "  with Normal:" << f.m_vNormal;
        //------------------------------------------------------------
        // Output texture coordinates
        #ifdef  TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
            output << "\n  it has m_sviVertexTextureList of size " << f.m_sviVertexTextureList.size();
        #else //TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
            output << "\n  and 2-D Texture Coordinates (" 
                   << static_cast<int>(f.m_2DTexCoordsVector.size()) << "):";
            for ( int i = 0; i < static_cast<int>(f.m_2DTexCoordsVector.size()); ++i )
            {
                output << "  " << f.m_2DTexCoordsVector[i];
            }
        #endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
        //------------------------------------------------------------
        // Output incident half-edge
        output << "\n  and Incident half-edge:" << f.nIncidentHalfEdge;
        return output;
    }
    //-------------------------------------------------------------------------
    // Constructors and destructor

    HEFace ( Vector3<T> normal = Vector3<T>() );
    HEFace ( HEHalfEdge<T> * const incidentHalfEdge );
    HEFace ( HEFace<T> const &he );
    virtual ~HEFace ();

    //-------------------------------------------------------------------------
    // Fn(s) for Normal

    inline void SetNormal( Vector3<T> normal )  { m_vNormal = normal; }
    inline void SetNormal( T x, T y, T z )  { m_vNormal.SetXYZ( x, y, z ); }
    inline Vector3<T> const & GetNormal() const { return m_vNormal; }

    //-------------------------------------------------------------------------
    // Member Access for Texture Coordinates
    inline int  GetNoTexCoords() const;
    inline int  GetNumTexCoords() const     { return GetNoTexCoords(); }
    inline T    GetTexCoordNoS( int i ) const;
    inline T    GetTexCoordNoT( int i ) const;
    inline void GetTexCoordNoS( int i, T &s ) const;
    inline void GetTexCoordNoT( int i, T &t ) const;
    inline void SetTexCoordNoS( int i, T s );
    inline void SetTexCoordNoT( int i, T t );
    inline void GetTexCoordNo( int i, T &s, T &t ) const;
    inline void SetTexCoordNo( int i, T s, T t );
    inline T    GetTexCoordHalfNo( int i ) const;
    inline void GetTexCoordHalfNo( int i, T &v ) const;
    inline void SetTexCoordHalfNo( int i, T v );
    inline void InsertTexCoordNo( int i, T s, T t );
    inline void AppendTexCoord( T s, T t );
    inline void RemoveTexCoordNo( int i );
    //-------------------------------------------------------------------------
#ifdef  TAPs_SUPPORT_ASE_FORMAT

    inline void          SetMaterialID ( unsigned char id ) { m_iSubmatID = id; }
    inline unsigned char GetMaterialID () const             { return m_iSubmatID; }
#endif//TAPs_SUPPORT_ASE_FORMAT

#ifdef  TAPs_ENABLE_FACE_VERTEX_COLOR
    inline void InitVertexColorList( int i );
    inline int  GetVertexColorNo( int i ) const;
    inline void SetVertexColorNo( int i, int vNo );
#endif//TAPs_ENABLE_FACE_VERTEX_COLOR

#ifdef  TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES
    inline void InitVertexTextureList( int i );
    inline int  GetVertexTextureNo( int i ) const;
    inline void SetVertexTextureNo( int i, int vNo );
#endif//TAPs_ENABLE_FACE_VERTEX_TEXTURE_COORDINATES

    //-------------------------------------------------------------------------
    // Member Access for Incident Half-Edge
    inline void IncidentHalfEdge( HEHalfEdge<T> * const incidentHalfEdge )
    { nIncidentHalfEdge = incidentHalfEdge; }
    inline HEHalfEdge<T> * IncidentHalfEdge() const
    { return nIncidentHalfEdge; }
    //-------------------------------------------------------------------------
    // Operations

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

    HEFace<T> * Insert ( HEFace<T> * const n );
    HEFace<T> * Remove ();
    inline void Delete ();
    HEFace<T> * Splice ( HEFace<T> * const n );

    //-------------------------------------------------------------------------
    // Data Conversion(s) / Operation(s)

    int CountNumberOfVertices () const;
    std::vector< HEVertex<T> * const >          GetPtrsToVertices ();
    std::vector< HEVertex<T> const * const >    GetPtrsToVertices () const;
    std::vector< HEVertex<T> * const >          GetPtrsToVerticesAndNumberOfVertices ( int & numberOfVertices );
    std::vector< HEVertex<T> const * const >    GetPtrsToVerticesAndNumberOfVertices ( int & numberOfVertices ) const;
    std::vector< HEVertex<T> * const >          GetPtrsToVertices ( int i );
    std::vector< HEVertex<T> const * const >    GetPtrsToVertices ( int i ) const;
    std::vector< Vector3<T> >   GetCopyOfVertexPositions () const;
    std::vector< Vector3<T> >   GetCopyOfVertexPositions ( int i ) const;

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