patchTables.h

Go to the documentation of this file.

//
//   Copyright 2013 Pixar
//
//   Licensed under the Apache License, Version 2.0 (the "Apache License")
//   with the following modification; you may not use this file except in
//   compliance with the Apache License and the following modification to it:
//   Section 6. Trademarks. is deleted and replaced with:
//
//   6. Trademarks. This License does not grant permission to use the trade
//      names, trademarks, service marks, or product names of the Licensor
//      and its affiliates, except as required to comply with Section 4(c) of
//      the License and to reproduce the content of the NOTICE file.
//
//   You may obtain a copy of the Apache License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the Apache License with the above modification is
//   distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
//   KIND, either express or implied. See the Apache License for the specific
//   language governing permissions and limitations under the Apache License.
//

#ifndef FAR_PATCH_TABLES_H
#define FAR_PATCH_TABLES_H

#include "../version.h"

#include "../far/patchParam.h"
#include "../far/types.h"

#include <cstdlib>
#include <cassert>
#include <algorithm>
#include <vector>
#include <map>

namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {

namespace Far {

class PatchTables {

public:
    typedef std::vector<unsigned int>  PTable;
    typedef std::vector<int>           VertexValenceTable;
    typedef std::vector<unsigned int>  QuadOffsetTable;
    typedef std::vector<PatchParam> PatchParamTable;

    enum Type {
        NON_PATCH = 0,     

        POINTS,            
        LINES,             

        QUADS,             
        TRIANGLES,         

        LOOP,              

        REGULAR,           
        BOUNDARY,
        CORNER,
        GREGORY,
        GREGORY_BOUNDARY
    };

    enum TransitionPattern {
        NON_TRANSITION = 0,
        PATTERN0,
        PATTERN1,
        PATTERN2,
        PATTERN3,
        PATTERN4
    };

    class Descriptor {

    public:
        Descriptor() :
            _type(NON_PATCH), _pattern(NON_TRANSITION), _rotation(0) {}

        Descriptor(int type, int pattern, unsigned char rotation) :
            _type(type), _pattern(pattern), _rotation(rotation) { }

        Descriptor( Descriptor const & d ) :
            _type(d.GetType()), _pattern(d.GetPattern()), _rotation(d.GetRotation()) { }

        Type GetType() const {
            return (Type)_type;
        }

        TransitionPattern GetPattern() const {
            return (TransitionPattern)_pattern;
        }

        unsigned char GetRotation() const {
            return (unsigned char)_rotation;
        }

        static inline short GetNumControlVertices( Type t );

        static inline short GetNumFVarControlVertices( Type t );

        short GetNumControlVertices() const {
            return GetNumControlVertices( this->GetType() );
        }

        short GetNumFVarControlVertices() const {
            return GetNumFVarControlVertices( this->GetType() );
        }

        static inline std::vector<Descriptor> const & GetAllValidDescriptors();

        inline bool operator < ( Descriptor const other ) const;

        inline bool operator == ( Descriptor const other ) const;

        class iterator;

        enum PrimType {
            ANY,
            FEATURE_ADAPTIVE_CATMARK
        };

        static iterator begin(PrimType type);

        static iterator end();

    private:
        friend class PatchTablesFactory;
        friend class iterator;

        unsigned int  _type:4;
        unsigned int  _pattern:3;
        unsigned int  _rotation:2;
    };




    class PatchArray {

    public:
        PatchArray( Descriptor desc, unsigned int vertIndex, unsigned int patchIndex, unsigned int npatches, unsigned int quadOffsetIndex ) :
            _desc(desc), _range(vertIndex, patchIndex, npatches, quadOffsetIndex) { }

        Descriptor GetDescriptor() const {
            return _desc;
        }

        struct ArrayRange {

            ArrayRange( unsigned int ivertIndex, unsigned int ipatchIndex, unsigned int inpatches, unsigned int iquadOffsetIndex ) :
                vertIndex(ivertIndex), patchIndex(ipatchIndex), npatches(inpatches), quadOffsetIndex(iquadOffsetIndex) { }

            unsigned int vertIndex,       // absolute index to the first control vertex of the first patch in the PTable
                         patchIndex,      // absolute index of the first patch in the array
                         npatches,        // number of patches in the array
                         quadOffsetIndex; // absolute index of the first quad offset entry
        };

        ArrayRange const & GetArrayRange() const {
            return _range;
        }

        unsigned int GetVertIndex() const {
            return _range.vertIndex;
        }

        unsigned int GetPatchIndex() const {
            return _range.patchIndex;
        }

        unsigned int GetNumPatches() const {
            return _range.npatches;
        }

        unsigned int GetQuadOffsetIndex() const {
            return _range.quadOffsetIndex;
        }

    private:
        friend class PatchTablesFactory;

        Descriptor _desc;   // type of patches in the array

        ArrayRange _range;  // index locators in the array
    };

    typedef std::vector<PatchArray> PatchArrayVector;

    PTable const & GetPatchTable() const { return _patches; }

    PatchArray const * GetPatchArray( Descriptor desc ) const {
        return const_cast<PatchTables *>(this)->findPatchArray( desc );
    }

    PatchArrayVector const & GetPatchArrayVector() const {
        return _patchArrays;
    }

    PatchArray const * GetPatchArray(int level=0) const;

    unsigned int const * GetFaceVertices(int level=0) const;

    int GetNumFaces(int level=0) const;

    VertexValenceTable const & GetVertexValenceTable() const { return _vertexValenceTable; }

    QuadOffsetTable const & GetQuadOffsetTable() const { return _quadOffsetTable; }

    PatchParamTable const & GetPatchParamTable() const { return _paramTable; }

    static short GetRegularPatchRingsize() { return 16; }

    static short GetBoundaryPatchRingsize() { return 12; }

    static short GetCornerPatchRingsize() { return 9; }

    static short GetGregoryPatchRingsize() { return 4; }

    int GetNumPatches() const;

    int GetNumControlVertices() const;

    int GetMaxValence() const { return _maxValence; }

    bool IsFeatureAdaptive() const;

    int GetNumPtexFaces() const { return _numPtexFaces; }

    class FVarPatchTables {

    public:

        int GetNumChannels() const {
            return (int)_channels.size();
        }

        std::vector<unsigned int> const & GetPatchVertices(int channel) const {
            return _channels[channel].patchVertIndices;
        }

    private:
        friend class PatchTablesFactory;

        struct Channel {
            friend class PatchTablesFactory;

            std::vector<unsigned int> patchVertIndices; // face-varying vertex indices
        };

        std::vector<Channel> _channels; // face-varying primvar channels
    };

    FVarPatchTables const * GetFVarPatchTables() const { return _fvarPatchTables; }

    PatchTables(PatchArrayVector const & patchArrays,
                   PTable const & patches,
                   VertexValenceTable const * vertexValences,
                   QuadOffsetTable const * quadOffsets,
                   PatchParamTable const * patchParams,
                   FVarPatchTables const * fvarPatchTables,
                   int maxValence);

    ~PatchTables() { delete _fvarPatchTables; }

private:

    friend class PatchTablesFactory;

    // Returns the array of patches of type "desc", or NULL if there aren't any in the primitive
    inline PatchArray * findPatchArray( Descriptor desc );

    // Private constructor
    PatchTables( int maxvalence ) : _fvarPatchTables(0), _maxValence(maxvalence) { }

    PatchArrayVector     _patchArrays;        // Vector of descriptors for arrays of patches

    PTable               _patches;            // Indices of the control vertices of the patches

    VertexValenceTable   _vertexValenceTable; // vertex valence table (for Gregory patches)

    QuadOffsetTable      _quadOffsetTable;    // quad offsets table (for Gregory patches)

    PatchParamTable      _paramTable;

    FVarPatchTables const * _fvarPatchTables; // sparse face-varying patch table

    // highest vertex valence allowed in the mesh (used for Gregory
    // vertexValance & quadOffset tables)
    int _maxValence;

    // number of total ptex faces in quads or triangles(loop)
    int _numPtexFaces;

};

class PatchTables::Descriptor::iterator {
    public:

        iterator() : _pos(-1) {}

        iterator(Descriptor desc);

        iterator & operator ++ ();

        bool operator == ( iterator const & other ) const {
            return (_pos==other._pos);
        }

        bool operator != ( iterator const & other ) const {
            return not (*this==other);
        }

        Descriptor const * operator -> () const {
            return  getValue();
        }

        Descriptor const & operator * () const {
            return *getValue();
        }

    private:
        inline Descriptor const * getValue() const;

        int _pos;
};

// Iterator constructor
inline PatchTables::Descriptor::iterator::iterator(Descriptor desc) {

    _pos = -1;
    std::vector<Descriptor> const & descs =
        Descriptor::GetAllValidDescriptors();

    for (int i=0; i<(int)descs.size(); ++i) {
        if (descs[i] == desc) {
            _pos = i;
            break;
        }
    }
}

// Iteration increment operator
inline PatchTables::Descriptor::iterator &
PatchTables::Descriptor::iterator::operator ++ () {

    if (++_pos>=(int)Descriptor::GetAllValidDescriptors().size()) {
        _pos = -1;
    }
    return *this;
}

inline PatchTables::Descriptor const *
PatchTables::Descriptor::iterator::getValue() const {

    static Descriptor _nonpatch;

    std::vector<Descriptor> const & descs =
        Descriptor::GetAllValidDescriptors();

    if (_pos>=0 and _pos<(int)descs.size()) {
        return &descs[_pos];
    }

    return &_nonpatch;
}

inline std::vector<PatchTables::Descriptor> const &
PatchTables::Descriptor::GetAllValidDescriptors() {

    static std::vector<Descriptor> _descriptors;

    if (_descriptors.empty()) {
        _descriptors.reserve(55);

        // non-patch primitives
        for (int i=POINTS; i<=LOOP; ++i) {
            _descriptors.push_back( Descriptor(i, NON_TRANSITION, 0) );
        }

        // non-transition patches
        for (int i=REGULAR; i<=GREGORY_BOUNDARY; ++i) {
            _descriptors.push_back( Descriptor(i, NON_TRANSITION, 0) );
        }

        // transition patches
        for (int i=PATTERN0; i<=PATTERN4; ++i) {

            _descriptors.push_back( Descriptor(REGULAR, i, 0) );

            // 4 rotations for boundary & corner patches
            for (int j=0; j<4; ++j) {
                _descriptors.push_back( Descriptor(BOUNDARY, i, j) );
            }

            for (int j=0; j<4; ++j) {
                _descriptors.push_back( Descriptor(CORNER, i, j) );
            }
        }
    }

    return _descriptors;
}

// Returns an iterator to the first type of patch (REGULAR NON_TRANSITION ROT0)
inline PatchTables::Descriptor::iterator
PatchTables::Descriptor::begin(PrimType type) {
    switch (type) {
        case ANY:
            return iterator( Descriptor(POINTS, NON_TRANSITION, 0) );
        case FEATURE_ADAPTIVE_CATMARK:
            return iterator( Descriptor(REGULAR, NON_TRANSITION, 0) );
        default:
            return iterator( Descriptor() );
    }
}

// Returns an iterator to the end of the list of patch types (NON_PATCH)
inline PatchTables::Descriptor::iterator
PatchTables::Descriptor::end() {
    return iterator( Descriptor() );
}

// Constructor
inline
PatchTables::PatchTables(PatchArrayVector const & patchArrays,
                               PTable const & patches,
                               VertexValenceTable const * vertexValences,
                               QuadOffsetTable const * quadOffsets,
                               PatchParamTable const * patchParams,
                               FVarPatchTables const * fvarPatchTables,
                               int maxValence) :
    _patchArrays(patchArrays),
    _patches(patches),
    _fvarPatchTables(fvarPatchTables),
    _maxValence(maxValence),
    _numPtexFaces(0) {

    // copy other tables if exist
    if (vertexValences)
        _vertexValenceTable = *vertexValences;
    if (quadOffsets)
        _quadOffsetTable = *quadOffsets;
    if (patchParams)
        _paramTable = *patchParams;
}

inline bool
PatchTables::IsFeatureAdaptive() const {

    // the vertex valence table is only used by Gregory patches, so the PatchTables
    // contain feature adaptive patches if this is not empty.
    if (not _vertexValenceTable.empty())
        return true;

    PatchArrayVector const & parrays = GetPatchArrayVector();

    // otherwise, we have to check each patch array
    for (int i=0; i<(int)parrays.size(); ++i) {

        if (parrays[i].GetDescriptor().GetType() >= REGULAR and
            parrays[i].GetDescriptor().GetType() <= GREGORY_BOUNDARY)
            return true;

    }
    return false;
}

// Returns the number of control vertices expected for a patch of this type
inline short
PatchTables::Descriptor::GetNumControlVertices( PatchTables::Type type ) {
    switch (type) {
        case REGULAR           : return PatchTables::GetRegularPatchRingsize();
        case QUADS             : return 4;
        case GREGORY           :
        case GREGORY_BOUNDARY  : return PatchTables::GetGregoryPatchRingsize();
        case BOUNDARY          : return PatchTables::GetBoundaryPatchRingsize();
        case CORNER            : return PatchTables::GetCornerPatchRingsize();
        case TRIANGLES         : return 3;
        case LINES             : return 2;
        case POINTS            : return 1;
        default : return -1;
    }
}

// Returns the total number of control vertex indices in the tables
inline int
PatchTables::GetNumControlVertices() const {

    int result=0;
    for (int i=0; i<(int)_patchArrays.size(); ++i) {
        result += _patchArrays[i].GetDescriptor().GetNumControlVertices() *
                  _patchArrays[i].GetNumPatches();
    }

    return result;
}

// Returns the number of face-varying control vertices expected for a patch of this type
inline short
PatchTables::Descriptor::GetNumFVarControlVertices( PatchTables::Type type ) {
    switch (type) {
        case REGULAR           : // We only support bilinear interpolation for now,
        case QUADS             : // so all these patches only carry 4 CVs.
        case GREGORY           :
        case GREGORY_BOUNDARY  :
        case BOUNDARY          :
        case CORNER            : return 4;
        case TRIANGLES         : return 3;
        case LINES             : return 2;
        case POINTS            : return 1;
        default : return -1;
    }
}

// Returns a pointer to the PatchArry of uniformly subdivided faces at 'level'
inline PatchTables::PatchArray const *
PatchTables::GetPatchArray(int level) const {

    if (IsFeatureAdaptive())
        return NULL;

    PatchArrayVector const & parrays = GetPatchArrayVector();

    if (parrays.empty())
        return NULL;

    if (level < 1) {
        return &(*parrays.rbegin());
    } else if ((level-1) < (int)parrays.size() ) {
        return &parrays[level-1];
    }

    return NULL;
}

// Returns a pointer to the vertex indices of uniformly subdivided faces
inline unsigned int const *
PatchTables::GetFaceVertices(int level) const {

    PatchArray const * parray = GetPatchArray(level);

    if (parray) {
        return &GetPatchTable()[ parray->GetVertIndex() ];
    }
    return NULL;
}

// Returns the number of faces in a uniformly subdivided mesh at a given level
inline int
PatchTables::GetNumFaces(int level) const {

    PatchArray const * parray = GetPatchArray(level);

    if (parray) {
        return parray->GetNumPatches();
    }
    return -1;
}

// Allows ordering of patches by type
inline bool
PatchTables::Descriptor::operator < ( Descriptor const other ) const {
    return _pattern < other._pattern or ((_pattern == other._pattern) and
          (_type < other._type or ((_type == other._type) and
          (_rotation < other._rotation))));
}

// True if the descriptors are identical
inline bool
PatchTables::Descriptor::operator == ( Descriptor const other ) const {
    return     _pattern == other._pattern    and
                  _type == other._type       and
              _rotation == other._rotation;
}

// Returns a pointer to the array of patches matching the descriptor
inline PatchTables::PatchArray *
PatchTables::findPatchArray( PatchTables::Descriptor desc ) {

    for (int i=0; i<(int)_patchArrays.size(); ++i) {
        if (_patchArrays[i].GetDescriptor()==desc)
            return &_patchArrays[i];
    }
    return 0;
}

// Returns the total number of patches stored in the tables
inline int
PatchTables::GetNumPatches() const {
    // there is one PatchParam record for each patch in the mesh
    return (int)GetPatchParamTable().size();
}

} // end namespace Far

} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;

} // end namespace OpenSubdiv

#endif /* FAR_PATCH_TABLES */