TAPsVertexRings2.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsVertexRings.hpp

VertexRings class is a class for generic 3D vertex rings.

Definition:
===========
The data structure is similar to the data structure for sparse matrices:
    std::vector<int> m_viRingLayers contains the size of each ring:
        +-+-+-+-+ ... +-+-+
        |0|a|b|c| ... |k|n|
        +-+-+-+-+ ... +-+-+
        where a   is the number of vertices in the zeroth ring,
              b-a is the number of vertices in the first ring,
              c-b is the number of vertices in the second ring and so on,
              n-k is the number of vertices in the last ring.
        The number of rings is m_viRingLayers.size()-2.
    std::vector<int> m_viRingVertices contains the list of vertices:
        +-+-+-+-+ ... +-+
        |i|j|k|l| ... |m|
        +-+-+-+-+ ... +-+
        where each character represents the vertex number in a mesh model.
    Need to known the number of vertices and pointers to the first vertex ring 
    of each vertex.
    e.g. in class XPolygonalModel has this vertex ring property (data member)
         std::vector<int> * m_pviVertexRing1List;   // neighbor vertices in ring 1

SUKITTI PUNAK   (11/18/2004)
UPDATE          (11/18/2004)
******************************************************************************/
#ifndef TAPs_VERTEX_RINGS_HPP
#define TAPs_VERTEX_RINGS_HPP

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

BEGIN_NAMESPACE_TAPs
//=============================================================================
class VertexRings {
//=============================================================================
protected:
    int *   m_paiRingLayers;        // contains the size of each layer
    int     m_iSizeOfRingLayers;    // size of ring layers
    int *   m_paiRingVertices;      // contains the list of ring vertices
    int     m_iSizeOfRingVertices;  // size of ring vertices
    int *   m_paiVertexNo;          // contains the current step (size must be m_iNoVertices)
    int     m_iNoVertices;          // Number of Vertices
    int     m_iCurruntStep;         // [0,std::numeric_limits<int>::max()] 
                                    // then will be reset to zero and 
                                    // m_paiVertexNo will be reset to zeroes.

    // This pointer points to the first vertex ring of each vertex, must be known 
    // in advanced in order to use this VertexRings operations
    // e.g. in class XPolygonalModel has this vertex ring property (data member)
    //   std::vector<int> * m_pviVertexRing1List;   // neighbor vertices in ring 1
    std::vector<int> const * m_pviVertexRing1List;
//=============================================================================
public:
    //-------------------------------------------------------------------------
    // Output Operator <<
    friend std::ostream & operator<< ( std::ostream &output, VertexRings const &vr )
    {
        //------------------------------------------------------------
        // Display Vertex Rings
        output  << "VertexRings";
        //------------------------------------------------------------
        // Display Face Ring
        for ( int i = 0; i < static_cast<int>(vr.m_viRingLayers.size())-1; ++i ) {
            output << "\n  Ring#" << i << ":";
            for ( int j = vr.m_viRingLayers[i]; j < vr.m_viRingLayers[i+1]; ++j ) {
                output << " " << vr.m_viRingVertices[j];
            }
        }
        return output;
    }
    //-------------------------------------------------------------------------
    // Constructors
    VertexRings ( std::vector<int> const * const pviVertexRing1List = NULL );   // default constructor
    virtual ~VertexRings ();    // destructor
    //-------------------------------------------------------------------------
    // Get/Set Fn(s)
    inline void SetExternalVertexRingInfo ( std::vector<int> * pviVertexRing1List )
        { m_pviVertexRing1List = pviVertexRing1List; }
    inline std::vector<int> & GetRingLayers()   { return m_viRingLayers; };
    inline std::vector<int> & GetRingVertices() { return m_viRingVertices; };
    inline int GetNoRings () const  { return static_cast<int>(m_viRingLayers.size())-2; }
    //void SetRingLayers ( std::vector<int> faceRing )      { m_viFaceRing = faceRing; }
    inline int GetSizeOfRingNo ( int i ) const 
        { return m_viRingLayers[i]-m_viRingLayers[i-1]; }
    //==========================================================================
    // OPERATIONS
    //-------------------------------------------------------------------------
    // Set vertex#i to the list of zeroth ring
    inline bool SetVertex ( int i );
    //-------------------------------------------------------------------------
    // Set vertices to the list of zeroth ring
        // v[] is the list of vertices to be set
        // size is the size of the list
    inline bool SetVertices ( int v[], int size );
    //-------------------------------------------------------------------------
    // Add vertex#i to the list of zeroth ring
    //inline bool AddVertex ( int i );
    //-------------------------------------------------------------------------
    // Add vertices to the list of zeroth ring
        // v[] is the list of vertices to be added
        // size is the size of the list
    //inline bool AddVertices ( int v[], int size );
    //-------------------------------------------------------------------------
    // Increase one layer
    inline bool IncreaseOneLayer ();
    //-------------------------------------------------------------------------
    // Decrease one layer
    inline bool DecreaseOneLayer ();
    //-------------------------------------------------------------------------
    // Assignment Operator
private:
    inline VertexRings & operator= ( VertexRings const &vr ) {}
    //-------------------------------------------------------------------------
}; // END CLASS VertexRings
//=============================================================================
END_NAMESPACE_TAPs
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
#if !defined( TAPs_USE_EXPORT )
    #include "TAPsVertexRings.cpp"
#endif
//-----------------------------------------------------------------------------
#endif
//345678901234567890123456789012345678901234567890123456789012345678901234567890
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8