OpenSubdiv/opensubdiv/far/topologyRefiner.h

//
//   Copyright 2014 DreamWorks Animation LLC.
//
//   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_TOPOLOGY_REFINER_H
#define FAR_TOPOLOGY_REFINER_H

#include "../version.h"

#include "../sdc/type.h"
#include "../sdc/options.h"
#include "../sdc/catmarkScheme.h"
#include "../vtr/level.h"
#include "../vtr/fvarLevel.h"
#include "../vtr/refinement.h"
#include "../vtr/fvarRefinement.h"
#include "../vtr/maskInterfaces.h"
#include "../far/types.h"

#include <vector>
#include <cassert>
#include <cstdio>

namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {

namespace Vtr { class SparseSelector; }

namespace Far {

template <class MESH> class TopologyRefinerFactory;

///
///  \brief Stores topology data for a specified set of refinement options.
///
class TopologyRefiner {

public:

    /// \brief Constructor
    TopologyRefiner(Sdc::Type type, Sdc::Options options = Sdc::Options());

    /// \brief Destructor
    ~TopologyRefiner();

    /// \brief Returns the subdivision scheme
    Sdc::Type    GetSchemeType() const    { return _subdivType; }

    /// \brief Returns the subdivision options
    Sdc::Options GetSchemeOptions() const { return _subdivOptions; }

    /// \brief Returns true if uniform subdivision has been applied
    bool IsUniform() const   { return _isUniform; }

    /// \brief Returns the highest level of refinement
    int  GetMaxLevel() const { return _maxLevel; }

    // XXXX barfowl -- should cache these internally for trivial return)

    /// \brief Returns the total number of vertices in all levels
    int GetNumVerticesTotal() const;

    /// \brief Returns the total number of edges in all levels
    int GetNumEdgesTotal() const;

    /// \brief Returns the total number of edges in all levels
    int GetNumFacesTotal() const;

    /// \brief Returns the total number of face vertices in all levels
    int GetNumFaceVerticesTotal() const;


    //
    //  High level refinement and related methods:
    //
    //  XXXX barfowl --  need some variants here for different refinement
    //                   options, i.e. single refine method plus struct
    //                   RefineOptions
    //


    /// \brief Refine the topology uniformly
    ///
    /// @param maxLevel                 Highest level of subdivision refinement
    ///
    /// @param fullTopologyInLastLevel  Skip secondary topological relationships
    ///                                 at the highest level of refinement.
    ///
    void RefineUniform(int maxLevel, bool fullTopologyInLastLevel = false);

    /// \brief Feature Adaptive topology refinement
    ///
    /// @param maxLevel                 Highest level of subdivision refinement
    ///
    /// @param fullTopologyInLastLevel  Skip secondary topological relationships
    ///                                 at the highest level of refinement.
    ///
    void RefineAdaptive(int maxLevel, bool fullTopologyInLastLevel = false);

    /// \brief Unrefine the topology (keep control cage)
    void Unrefine();

    /// \brief Clear the topology entirely
    void Clear();

#ifdef _VTR_COMPUTE_MASK_WEIGHTS_ENABLED
    void ComputeMaskWeights();
#endif


    //
    //  Primvar data interpolation:
    //


    /// \brief Apply vertex and varying interpolation weights to a primvar
    ///        buffer
    ///
    /// The destination buffer must allocate an array of data for all the
    /// refined vertices (at least GetNumVerticesTotal()-GetNumVertices(0))
    ///
    /// @param src  Source primvar buffer (control vertex data)
    ///
    /// @param dst  Destination primvar buffer (refined vertex data)
    ///
    template <class T, class U> void Interpolate(T const * src, U * dst) const;

    /// \brief Apply vertex and varying interpolation weights to a primvar
    ///        buffer for a single level
    /// level of refinement.
    ///
    /// The destination buffer must allocate an array of data for all the
    /// refined vertices (at least GetNumVertices(level))
    ///
    /// @param level  The refinement level
    ///
    /// @param src    Source primvar buffer (control vertex data)
    ///
    /// @param dst    Destination primvar buffer (refined vertex data)
    ///
    template <class T, class U> void Interpolate(int level, T const * src, U * dst) const;


    /// \brief Apply only varying interpolation weights to a primvar buffer
    ///
    /// This method can be a useful alternative if the varying primvar data
    /// does not need to be re-computed over time.
    ///
    /// The destination buffer must allocate an array of data for all the
    /// refined vertices (at least GetNumVerticesTotal()-GetNumVertices(0))
    ///
    /// @param src  Source primvar buffer (control vertex data)
    ///
    /// @param dst  Destination primvar buffer (refined vertex data)
    ///
    template <class T, class U> void InterpolateVarying(T const * src, U * dst) const;

    /// \brief Apply only varying interpolation weights to a primvar buffer
    ///        for a single level level of refinement.
    ///
    /// This method can be a useful alternative if the varying primvar data
    /// does not need to be re-computed over time.
    ///
    /// The destination buffer must allocate an array of data for all the
    /// refined vertices (at least GetNumVertices(level))
    ///
    /// @param level  The refinement level
    ///
    /// @param src    Source primvar buffer (control vertex data)
    ///
    /// @param dst    Destination primvar buffer (refined vertex data)
    ///
    template <class T, class U> void InterpolateVarying(int level, T const * src, U * dst) const;

    /// \brief Apply face-varying interpolation weights to a primvar buffer
    //         associated with a particular face-varying channel
    ///
    template <class T, class U> void InterpolateFaceVarying(T const * src, U * dst, int channel = 0) const;

    template <class T, class U> void InterpolateFaceVarying(int level, T const * src, U * dst, int channel = 0) const;


    /// \brief Apply vertex interpolation limit weights to a primvar buffer
    ///
    /// The source buffer must refer to an array of previously interpolated
    /// vertex data for the last refinement level.  The destination buffer
    /// must allocate an array for all vertices at the last refinement level
    /// (at least GetNumVertices(GetMaxLevel()))
    ///
    /// @param src  Source primvar buffer (refined vertex data) for last level
    ///
    /// @param dst  Destination primvar buffer (vertex data at the limit)
    ///
    template <class T, class U> void Limit(T const * src, U * dst) const;


    //
    //  Inspection of components per level:
    //


    /// \brief Returns the number of vertices at a given level of refinement
    int GetNumVertices(int level) const {
        return _levels[level].getNumVertices();
    }

    /// \brief Returns the number of edges at a given level of refinement
    int GetNumEdges(int level) const {
        return _levels[level].getNumEdges();
    }

    /// \brief Returns the number of face vertex indices at a given level of refinement
    int GetNumFaces(int level) const {
        return _levels[level].getNumFaces();
    }

    /// \brief Returns the number of faces at a given level of refinement
    int GetNumFaceVertices(int level) const {
        return _levels[level].getNumFaceVerticesTotal();
    }

    /// \brief Returns the sharpness of a given edge (at 'level' of refinement)
    float GetEdgeSharpness(int level, Index edge) const {
        return _levels[level].getEdgeSharpness(edge);
    }

    /// \brief Returns the sharpness of a given vertex (at 'level' of refinement)
    float GetVertexSharpness(int level, Index vert) const {
        return _levels[level].getVertexSharpness(vert);
    }

    /// \brief Returns the subdivision rule of a given vertex (at 'level' of refinement)
    Sdc::Crease::Rule GetVertexRule(int level, Index vert) const {
        return _levels[level].getVertexRule(vert);
    }


    //
    //  Topological relations -- incident/adjacent components:
    //


    /// \brief Returns the vertices of a 'face' at 'level'
    IndexArray const GetFaceVertices(int level, Index face) const {
        return _levels[level].getFaceVertices(face);
    }

    /// \brief Returns the edges of a 'face' at 'level'
    IndexArray const GetFaceEdges(   int level, Index face) const {
        return _levels[level].getFaceEdges(face);
    }

    /// \brief Returns the vertices of an 'edge' at 'level' (2 of them)
    IndexArray const GetEdgeVertices(int level, Index edge) const {
        return _levels[level].getEdgeVertices(edge);
    }

    /// \brief Returns the faces incident to 'edge' at 'level'
    IndexArray const GetEdgeFaces(   int level, Index edge) const {
        return _levels[level].getEdgeFaces(edge);
    }

    /// \brief Returns the faces incident to 'vertex' at 'level'
    IndexArray const GetVertexFaces( int level, Index vert) const {
        return _levels[level].getVertexFaces(vert);
    }

    /// \brief Returns the edges incident to 'vertex' at 'level'
    IndexArray const GetVertexEdges( int level, Index vert) const {
        return _levels[level].getVertexEdges(vert);
    }

    /// \brief Returns the local face indices of vertex 'vert' at 'level'
    LocalIndexArray const VertexFaceLocalIndices(int level, Index vert) const {
        return _levels[level].getVertexFaceLocalIndices(vert);
    }

    /// \brief Returns the local edge indices of vertex 'vert' at 'level'
    LocalIndexArray const VertexEdgeLocalIndices(int level, Index vert) const {
        return _levels[level].getVertexEdgeLocalIndices(vert);
    }

    /// \brief Returns the edge with vertices'v0' and 'v1' (or -1 if they are
    ///  not connected)
    Index FindEdge(int level, Index v0, Index v1) const {
        return _levels[level].findEdge(v0, v1);
    }


    //
    //  Inspection of face-varying channels and their contents:
    //


    /// \brief Returns the number of face-varying channels in the tables
    int GetNumFVarChannels() const {
        return _levels[0].getNumFVarChannels();
    }

    /// \brief Returns the total number of face-varying values in all levels
    int GetNumFVarValuesTotal(int channel = 0) const;

    /// \brief Returns the number of face-varying values at a given level of refinement
    int GetNumFVarValues(int level, int channel = 0) const {
        return _levels[level].getNumFVarValues(channel);
    }

    /// \brief Returns the face-varying values of a 'face' at 'level'
    IndexArray const GetFVarFaceValues(int level, Index face, int channel = 0) const {
        return _levels[level].getFVarFaceValues(face, channel);
    }


    //
    //  Parent-to-child relationships, i.e. relationships between components in one level
    //  and the next (entries may be invalid if sparse):
    //


    /// \brief Returns the child faces of face 'f' at 'level'
    IndexArray const GetFaceChildFaces(int level, Index f) const {
        return _refinements[level].getFaceChildFaces(f);
    }

    /// \brief Returns the child edges of face 'f' at 'level'
    IndexArray const GetFaceChildEdges(int level, Index f) const {
        return _refinements[level].getFaceChildEdges(f);
    }

    /// \brief Returns the child edges of edge 'e' at 'level'
    IndexArray const GetEdgeChildEdges(int level, Index e) const {
        return _refinements[level].getEdgeChildEdges(e);
    }

    /// \brief Returns the child vertex of face 'f' at 'level'
    Index GetFaceChildVertex(  int level, Index f) const {
        return _refinements[level].getFaceChildVertex(f);
    }

    /// \brief Returns the child vertex of edge 'e' at 'level'
    Index GetEdgeChildVertex(  int level, Index e) const {
        return _refinements[level].getEdgeChildVertex(e);
    }

    /// \brief Returns the child vertex of vertex 'v' at 'level'
    Index GetVertexChildVertex(int level, Index v) const {
        return _refinements[level].getVertexChildVertex(v);
    }


    //
    //  Ptex:
    //

    /// \brief Returns the number of ptex faces in the mesh
    int GetNumPtexFaces() const;

    /// \brief Returns the ptex face index given a coarse face 'f' or -1
    int GetPtexIndex(Index f) const;


    //
    //  Debugging aides:
    //


    /// \brief Returns true if the topology of 'level' is valid
    bool ValidateTopology(int level) const {
        return _levels[level].validateTopology();
    }

    /// \brief Prints topology information to console
    void PrintTopology(int level, bool children = true) const {
        _levels[level].print(children ? &_refinements[level] : 0);
    }


protected:

    //
    //  For use by the Factory base and subclasses to construct the base level:
    //
    template <class MESH>
    friend class TopologyRefinerFactory;
    friend class TopologyRefinerFactoryBase;
    friend class PatchTablesFactory;

    int                   getNumLevels() const { return (int)_levels.size(); }
    Vtr::Level            & getBaseLevel() { return _levels.front(); }
    Vtr::Level            & getLevel(int l) { return _levels[l]; }
    Vtr::Level const      & getLevel(int l) const { return _levels[l]; }
    Vtr::Refinement const & getRefinement(int l) const { return _refinements[l]; }

    int getNumBaseFaces() const    { return GetNumFaces(0); }
    int getNumBaseEdges() const    { return GetNumEdges(0); }
    int getNumBaseVertices() const { return GetNumVertices(0); }

    //  Sizing specifications required before allocation:
    void setNumBaseFaces(   int count) { _levels[0].resizeFaces(count); }
    void setNumBaseEdges(   int count) { _levels[0].resizeEdges(count); }
    void setNumBaseVertices(int count) { _levels[0].resizeVertices(count); }

    void setNumBaseFaceVertices(Index f, int count) { _levels[0].resizeFaceVertices(f, count); }
    void setNumBaseEdgeFaces(   Index e, int count) { _levels[0].resizeEdgeFaces(e, count); }
    void setNumBaseVertexFaces( Index v, int count) { _levels[0].resizeVertexFaces(v, count); }
    void setNumBaseVertexEdges( Index v, int count) { _levels[0].resizeVertexEdges(v, count); }

    //  Access to populate the base level topology after allocation:
    IndexArray setBaseFaceVertices(Index f) { return _levels[0].getFaceVertices(f); }
    IndexArray setBaseFaceEdges(   Index f) { return _levels[0].getFaceEdges(f); }
    IndexArray setBaseEdgeVertices(Index e) { return _levels[0].getEdgeVertices(e); }
    IndexArray setBaseEdgeFaces(   Index e) { return _levels[0].getEdgeFaces(e); }
    IndexArray setBaseVertexFaces( Index v) { return _levels[0].getVertexFaces(v); }
    IndexArray setBaseVertexEdges( Index v) { return _levels[0].getVertexEdges(v); }

    //  Not sure yet if we will determine these internally...
    LocalIndexArray setBaseVertexFaceLocalIndices(Index v) { return _levels[0].getVertexFaceLocalIndices(v); }
    LocalIndexArray setBaseVertexEdgeLocalIndices(Index v) { return _levels[0].getVertexEdgeLocalIndices(v); }

    //  Optionally available to get/set sharpness values:
    float& baseEdgeSharpness(Index e)   { return _levels[0].getEdgeSharpness(e); }
    float& baseVertexSharpness(Index v) { return _levels[0].getVertexSharpness(v); }

    //  Face-varying modifiers for constructing face-varying channels:
    int createFVarChannel(int numValues) {
        return _levels[0].createFVarChannel(numValues, _subdivOptions);
    }
    int createFVarChannel(int numValues, Sdc::Options const& options) {
        return _levels[0].createFVarChannel(numValues, options);
    }
    void completeFVarChannelTopology(int channel = 0) { _levels[0].completeFVarChannelTopology(channel); }

    IndexArray getBaseFVarFaceValues(Index face, int channel = 0) { return _levels[0].getFVarFaceValues(face, channel); }

    void populateLocalIndices() {
        getBaseLevel().populateLocalIndices();
    }

private:
    void catmarkFeatureAdaptiveSelector(Vtr::SparseSelector& selector);

    template <class T, class U> void interpolateChildVertsFromFaces(Vtr::Refinement const &, T const * src, U * dst) const;
    template <class T, class U> void interpolateChildVertsFromEdges(Vtr::Refinement const &, T const * src, U * dst) const;
    template <class T, class U> void interpolateChildVertsFromVerts(Vtr::Refinement const &, T const * src, U * dst) const;

    template <class T, class U> void varyingInterpolateChildVertsFromFaces(Vtr::Refinement const &, T const * src, U * dst) const;
    template <class T, class U> void varyingInterpolateChildVertsFromEdges(Vtr::Refinement const &, T const * src, U * dst) const;
    template <class T, class U> void varyingInterpolateChildVertsFromVerts(Vtr::Refinement const &, T const * src, U * dst) const;

    template <class T, class U> void faceVaryingInterpolateChildVertsFromFaces(Vtr::Refinement const &, T const * src, U * dst, int channel) const;
    template <class T, class U> void faceVaryingInterpolateChildVertsFromEdges(Vtr::Refinement const &, T const * src, U * dst, int channel) const;
    template <class T, class U> void faceVaryingInterpolateChildVertsFromVerts(Vtr::Refinement const &, T const * src, U * dst, int channel) const;


    void initializePtexIndices() const;

private:
    //  The following should be private but leaving it open while still early...
    Sdc::Type    _subdivType;
    Sdc::Options _subdivOptions;

    bool _isUniform;
    int  _maxLevel;

    std::vector<Vtr::Level>      _levels;
    std::vector<Vtr::Refinement> _refinements;

    std::vector<Index>         _ptexIndices;
};

template <class T, class U>
inline void
TopologyRefiner::Interpolate(T const * src, U * dst) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);

    for (int level=1; level<=GetMaxLevel(); ++level) {

        Interpolate(level, src, dst);

        src = dst;
        dst += GetNumVertices(level);
    }
}

template <class T, class U>
inline void
TopologyRefiner::Interpolate(int level, T const * src, U * dst) const {

    assert(level>0 and level<=(int)_refinements.size());

    Vtr::Refinement const & refinement = _refinements[level-1];

    interpolateChildVertsFromFaces(refinement, src, dst);
    interpolateChildVertsFromEdges(refinement, src, dst);
    interpolateChildVertsFromVerts(refinement, src, dst);
}

template <class T, class U>
inline void
TopologyRefiner::interpolateChildVertsFromFaces(
    Vtr::Refinement const & refinement, T const * src, U * dst) const {

    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    const Vtr::Level& parent = refinement.parent();

    float * fVertWeights = (float *)alloca(parent.getMaxValence()*sizeof(float));

    for (int face = 0; face < parent.getNumFaces(); ++face) {

        Vtr::Index cVert = refinement.getFaceChildVertex(face);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        //  Declare and compute mask weights for this vertex relative to its parent face:
        Vtr::IndexArray const fVerts = parent.getFaceVertices(face);

        float fVaryingWeight = 1.0f / (float) fVerts.size();

        Vtr::MaskInterface fMask(fVertWeights, 0, 0);
        Vtr::FaceInterface fHood(fVerts.size());

        scheme.ComputeFaceVertexMask(fHood, fMask);

        //  Apply the weights to the parent face's vertices:
        U & vdst = dst[cVert];

        vdst.Clear();

        for (int i = 0; i < fVerts.size(); ++i) {

            vdst.AddWithWeight(src[fVerts[i]], fVertWeights[i]);

            vdst.AddVaryingWithWeight(src[fVerts[i]], fVaryingWeight);
        }
    }
}

template <class T, class U>
inline void
TopologyRefiner::interpolateChildVertsFromEdges(
    Vtr::Refinement const & refinement, T const * src, U * dst) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);
    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    const Vtr::Level& parent = refinement.parent();
    const Vtr::Level& child  = refinement.child();

    Vtr::EdgeInterface eHood(parent);

    float   eVertWeights[2],
          * eFaceWeights = (float *)alloca(parent.getMaxEdgeFaces()*sizeof(float));

    for (int edge = 0; edge < parent.getNumEdges(); ++edge) {

        Vtr::Index cVert = refinement.getEdgeChildVertex(edge);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        //  Declare and compute mask weights for this vertex relative to its parent edge:
        Vtr::IndexArray const eVerts = parent.getEdgeVertices(edge);
        Vtr::IndexArray const eFaces = parent.getEdgeFaces(edge);

        Vtr::MaskInterface eMask(eVertWeights, 0, eFaceWeights);

        eHood.SetIndex(edge);

        Sdc::Crease::Rule pRule = (parent.getEdgeSharpness(edge) > 0.0) ? Sdc::Crease::RULE_CREASE : Sdc::Crease::RULE_SMOOTH;
        Sdc::Crease::Rule cRule = child.getVertexRule(cVert);

        scheme.ComputeEdgeVertexMask(eHood, eMask, pRule, cRule);

        //  Apply the weights to the parent edges's vertices and (if applicable) to
        //  the child vertices of its incident faces:
        U & vdst = dst[cVert];

        vdst.Clear();
        vdst.AddWithWeight(src[eVerts[0]], eVertWeights[0]);
        vdst.AddWithWeight(src[eVerts[1]], eVertWeights[1]);

        vdst.AddVaryingWithWeight(src[eVerts[0]], 0.5f);
        vdst.AddVaryingWithWeight(src[eVerts[1]], 0.5f);

        if (eMask.GetNumFaceWeights() > 0) {

            for (int i = 0; i < eFaces.size(); ++i) {

                Vtr::Index cVertOfFace = refinement.getFaceChildVertex(eFaces[i]);
                assert(Vtr::IndexIsValid(cVertOfFace));
                vdst.AddWithWeight(dst[cVertOfFace], eFaceWeights[i]);
            }
        }
    }
}

template <class T, class U>
inline void
TopologyRefiner::interpolateChildVertsFromVerts(
    Vtr::Refinement const & refinement, T const * src, U * dst) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);
    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    const Vtr::Level& parent = refinement.parent();
    const Vtr::Level& child  = refinement.child();

    Vtr::VertexInterface vHood(parent, child);

    float * weightBuffer = (float *)alloca(2*parent.getMaxValence()*sizeof(float));

    for (int vert = 0; vert < parent.getNumVertices(); ++vert) {

        Vtr::Index cVert = refinement.getVertexChildVertex(vert);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        //  Declare and compute mask weights for this vertex relative to its parent edge:
        Vtr::IndexArray const vEdges = parent.getVertexEdges(vert);
        Vtr::IndexArray const vFaces = parent.getVertexFaces(vert);

        float   vVertWeight,
              * vEdgeWeights = weightBuffer,
              * vFaceWeights = vEdgeWeights + vEdges.size();

        Vtr::MaskInterface vMask(&vVertWeight, vEdgeWeights, vFaceWeights);

        vHood.SetIndex(vert, cVert);

        Sdc::Crease::Rule pRule = parent.getVertexRule(vert);
        Sdc::Crease::Rule cRule = child.getVertexRule(cVert);

        scheme.ComputeVertexVertexMask(vHood, vMask, pRule, cRule);

        //  Apply the weights to the parent vertex, the vertices opposite its incident
        //  edges, and the child vertices of its incident faces:
        U & vdst = dst[cVert];

        vdst.Clear();
        vdst.AddWithWeight(src[vert], vVertWeight);
        vdst.AddVaryingWithWeight(src[vert], 1.0f);

        if (vMask.GetNumEdgeWeights() > 0) {

            for (int i = 0; i < vEdges.size(); ++i) {

                Vtr::IndexArray const eVerts = parent.getEdgeVertices(vEdges[i]);
                Vtr::Index pVertOppositeEdge = (eVerts[0] == vert) ? eVerts[1] : eVerts[0];

                vdst.AddWithWeight(src[pVertOppositeEdge], vEdgeWeights[i]);
            }
        }
        if (vMask.GetNumFaceWeights() > 0) {

            for (int i = 0; i < vFaces.size(); ++i) {

                Vtr::Index cVertOfFace = refinement.getFaceChildVertex(vFaces[i]);
                assert(Vtr::IndexIsValid(cVertOfFace));
                vdst.AddWithWeight(dst[cVertOfFace], vFaceWeights[i]);
            }
        }
    }
}

//
// Varying only interpolation
//

template <class T, class U>
inline void
TopologyRefiner::InterpolateVarying(T const * src, U * dst) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);

    for (int level=1; level<=GetMaxLevel(); ++level) {

        InterpolateVarying(level, src, dst);

        src = dst;
        dst += GetNumVertices(level);
    }
}

template <class T, class U>
inline void
TopologyRefiner::InterpolateVarying(int level, T const * src, U * dst) const {

    assert(level>0 and level<=(int)_refinements.size());

    Vtr::Refinement const & refinement = _refinements[level-1];

    varyingInterpolateChildVertsFromFaces(refinement, src, dst);
    varyingInterpolateChildVertsFromEdges(refinement, src, dst);
    varyingInterpolateChildVertsFromVerts(refinement, src, dst);
}

template <class T, class U>
inline void
TopologyRefiner::varyingInterpolateChildVertsFromFaces(
    Vtr::Refinement const & refinement, T const * src, U * dst) const {

    const Vtr::Level& parent = refinement.parent();

    for (int face = 0; face < parent.getNumFaces(); ++face) {

        Vtr::Index cVert = refinement.getFaceChildVertex(face);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        Vtr::IndexArray const fVerts = parent.getFaceVertices(face);

        float fVaryingWeight = 1.0f / (float) fVerts.size();

        //  Apply the weights to the parent face's vertices:
        U & vdst = dst[cVert];

        vdst.Clear();

        for (int i = 0; i < fVerts.size(); ++i) {
            vdst.AddVaryingWithWeight(src[fVerts[i]], fVaryingWeight);
        }
    }
}

template <class T, class U>
inline void
TopologyRefiner::varyingInterpolateChildVertsFromEdges(
    Vtr::Refinement const & refinement, T const * src, U * dst) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);

    const Vtr::Level& parent = refinement.parent();

    for (int edge = 0; edge < parent.getNumEdges(); ++edge) {

        Vtr::Index cVert = refinement.getEdgeChildVertex(edge);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        //  Declare and compute mask weights for this vertex relative to its parent edge:
        Vtr::IndexArray const eVerts = parent.getEdgeVertices(edge);

        //  Apply the weights to the parent edges's vertices
        U & vdst = dst[cVert];

        vdst.Clear();

        vdst.AddVaryingWithWeight(src[eVerts[0]], 0.5f);
        vdst.AddVaryingWithWeight(src[eVerts[1]], 0.5f);
    }
}

template <class T, class U>
inline void
TopologyRefiner::varyingInterpolateChildVertsFromVerts(
    Vtr::Refinement const & refinement, T const * src, U * dst) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);

    const Vtr::Level& parent = refinement.parent();

    for (int vert = 0; vert < parent.getNumVertices(); ++vert) {

        Vtr::Index cVert = refinement.getVertexChildVertex(vert);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        //  Apply the weights to the parent vertex
        U & vdst = dst[cVert];

        vdst.Clear();
        vdst.AddVaryingWithWeight(src[vert], 1.0f);
    }
}


//
// Face-varying only interpolation
//

template <class T, class U>
inline void
TopologyRefiner::InterpolateFaceVarying(T const * src, U * dst, int channel) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);

    for (int level=1; level<=GetMaxLevel(); ++level) {

        InterpolateFaceVarying(level, src, dst, channel);
        
        src = dst;
        dst += _levels[level].getNumFVarValues();
    }
}

template <class T, class U>
inline void
TopologyRefiner::InterpolateFaceVarying(int level, T const * src, U * dst, int channel) const {

    assert(level>0 and level<=(int)_refinements.size());

    Vtr::Refinement const & refinement = _refinements[level-1];

    faceVaryingInterpolateChildVertsFromFaces(refinement, src, dst, channel);
    faceVaryingInterpolateChildVertsFromEdges(refinement, src, dst, channel);
    faceVaryingInterpolateChildVertsFromVerts(refinement, src, dst, channel);
}

template <class T, class U>
inline void
TopologyRefiner::faceVaryingInterpolateChildVertsFromFaces(
    Vtr::Refinement const & refinement, T const * src, U * dst, int channel) const {

    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    const Vtr::Level& parent = refinement.parent();

    float * fValueWeights = (float *)alloca(parent.getMaxValence()*sizeof(float));

    for (int face = 0; face < parent.getNumFaces(); ++face) {

        Vtr::Index cVert = refinement.getFaceChildVertex(face);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        //  The only difference for face-varying here is that we get the values associated
        //  with each face-vertex directly from the FVarLevel, rather than using the parent
        //  face-vertices directly.  If any face-vertex has any sibling values, then we may
        //  get the wrong one using the face-vertex index directly.

        //  Declare and compute mask weights for this vertex relative to its parent face:
        Vtr::IndexArray const fValues = parent.getFVarFaceValues(face, channel);

        Vtr::MaskInterface fMask(fValueWeights, 0, 0);
        Vtr::FaceInterface fHood(fValues.size());

        scheme.ComputeFaceVertexMask(fHood, fMask);

        //  Apply the weights to the parent face's vertices:
        U & vdst = dst[cVert];

        vdst.Clear();

        for (int i = 0; i < fValues.size(); ++i) {
            vdst.AddWithWeight(src[fValues[i]], fValueWeights[i]);
        }
    }
}

template <class T, class U>
inline void
TopologyRefiner::faceVaryingInterpolateChildVertsFromEdges(
    Vtr::Refinement const & refinement, T const * src, U * dst, int channel) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);
    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    const Vtr::Level& parent = refinement.parent();
    const Vtr::Level& child  = refinement.child();

    const Vtr::FVarRefinement& refineFVar = *refinement._fvarChannels[channel];
    const Vtr::FVarLevel&      parentFVar = *parent._fvarChannels[channel];
    const Vtr::FVarLevel&      childFVar  = *child._fvarChannels[channel];

    //
    //  Allocate and intialize (if linearly interpolated) interpolation weights for
    //  the edge mask:
    //
    float   eVertWeights[2],
          * eFaceWeights = (float *)alloca(parent.getMaxEdgeFaces()*sizeof(float));

    Vtr::MaskInterface eMask(eVertWeights, 0, eFaceWeights);

    bool isLinearFVar = parentFVar._isLinear;
    if (isLinearFVar) {
        eMask.SetNumVertexWeights(2);
        eMask.SetNumEdgeWeights(0);
        eMask.SetNumFaceWeights(0);

        eVertWeights[0] = 0.5f;
        eVertWeights[1] = 0.5f;
    }

    Vtr::EdgeInterface eHood(parent);

    for (int edge = 0; edge < parent.getNumEdges(); ++edge) {

        Vtr::Index cVert = refinement.getEdgeChildVertex(edge);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        bool fvarEdgeVertMatchesVertex = childFVar.vertexTopologyMatches(cVert);
        if (fvarEdgeVertMatchesVertex) {
            //
            //  If smoothly interpolated, compute new weights for the edge mask:
            //
            if (!isLinearFVar) {
                eHood.SetIndex(edge);

                Sdc::Crease::Rule pRule = (parent.getEdgeSharpness(edge) > 0.0) ? Sdc::Crease::RULE_CREASE : Sdc::Crease::RULE_SMOOTH;
                Sdc::Crease::Rule cRule = child.getVertexRule(cVert);

                scheme.ComputeEdgeVertexMask(eHood, eMask, pRule, cRule);
            }

            //  Apply the weights to the parent edges's vertices and (if applicable) to
            //  the child vertices of its incident faces:
            //
            //  Even though the face-varying topology matches the vertex topology, we need
            //  to be careful here when getting values corresponding to the two end-vertices.
            //  While the edge may be continuous, the vertices at their ends may have
            //  discontinuities elsewhere in their neighborhood (i.e. on the "other side"
            //  of the end-vertex) and so have sibling values associated with them.  In most
            //  cases the topology for an end-vertex will match and we can use it directly,
            //  but we must still check and retrieve as needed.
            //
            //  Indices for values corresponding to face-vertices are guaranteed to match,
            //  so we can use the child-vertex indices directly.
            //
            //  And by "directly", we always use getVertexValue(vertexIndex) to reference
            //  values in the "src" to account for the possible indirection that may exist at
            //  level 0 -- where there may be fewer values than vertices and an additional
            //  indirection is necessary.  We can use a vertex index directly for "dst" when
            //  it matches.
            //
            Vtr::Index eVertValues[2];

            //  WORK-IN-PROGRESS -- using this switch for comparative purposes only...
            bool assumeMatchingNeighborhood = false;
            if (assumeMatchingNeighborhood) {
                Vtr::IndexArray eVerts = parent.getEdgeVertices(edge);
                eVertValues[0] = eVerts[0];
                eVertValues[1] = eVerts[1];
            } else {
                parentFVar.getEdgeFaceValues(edge, 0, eVertValues);
            }

            U & vdst = dst[cVert];

            vdst.Clear();
            vdst.AddWithWeight(src[eVertValues[0]], eVertWeights[0]);
            vdst.AddWithWeight(src[eVertValues[1]], eVertWeights[1]);

            if (eMask.GetNumFaceWeights() > 0) {

                Vtr::IndexArray const eFaces = parent.getEdgeFaces(edge);

                for (int i = 0; i < eFaces.size(); ++i) {

                    Vtr::Index cVertOfFace = refinement.getFaceChildVertex(eFaces[i]);
                    assert(Vtr::IndexIsValid(cVertOfFace));
                    vdst.AddWithWeight(dst[cVertOfFace], eFaceWeights[i]);
                }
            }
        } else {
            //
            //  Mismatched edge-verts should just be linearly interpolated between the pairs of
            //  values for each sibling of the child edge-vertex -- the question is:  which face
            //  holds that pair of values for a given sibling?
            //
            //  In the manifold case, the sibling and edge-face indices will correspond.  We
            //  will eventually need to update this to account for > 3 incident faces.
            //
            for (int i = 0; i < childFVar.getNumVertexValues(cVert); ++i) {
                Vtr::Index eVertValues[2];
                int      eFaceIndex = refineFVar.getChildValueParentSource(cVert, i);
                assert(eFaceIndex == i);

                parentFVar.getEdgeFaceValues(edge, eFaceIndex, eVertValues);

                U & vdst = dst[childFVar.getVertexValue(cVert, i)];

                vdst.Clear();
                vdst.AddWithWeight(src[eVertValues[0]], 0.5);
                vdst.AddWithWeight(src[eVertValues[1]], 0.5);
            }
        }
    }
}

template <class T, class U>
inline void
TopologyRefiner::faceVaryingInterpolateChildVertsFromVerts(
    Vtr::Refinement const & refinement, T const * src, U * dst, int channel) const {

    assert(_subdivType == Sdc::TYPE_CATMARK);
    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    const Vtr::Level& parent = refinement.parent();
    const Vtr::Level& child  = refinement.child();

    const Vtr::FVarRefinement& refineFVar = *refinement._fvarChannels[channel];
    const Vtr::FVarLevel&      parentFVar = *parent._fvarChannels[channel];
    const Vtr::FVarLevel&      childFVar  = *child._fvarChannels[channel];

    bool isLinearFVar = parentFVar._isLinear;

    float * weightBuffer = (float *)alloca(2*parent.getMaxValence()*sizeof(float));

    Vtr::Index * vEdgeValues = (Vtr::Index *)alloca(parent.getMaxValence()*sizeof(Vtr::Index));

    Vtr::VertexInterface vHood(parent, child);

    for (int vert = 0; vert < parent.getNumVertices(); ++vert) {

        Vtr::Index cVert = refinement.getVertexChildVertex(vert);
        if (!Vtr::IndexIsValid(cVert))
            continue;

        bool fvarVertVertMatchesVertex = childFVar.vertexTopologyMatches(cVert);
        if (isLinearFVar && fvarVertVertMatchesVertex) {
            Vtr::Index pVertValue = parentFVar.getVertexValue(vert);
            Vtr::Index cVertValue = cVert;

            U & vdst = dst[cVertValue];

            vdst.Clear();
            vdst.AddWithWeight(src[pVertValue], 1.0f);
            continue;
        }

        if (fvarVertVertMatchesVertex) {
            //
            //  Declare and compute mask weights for this vertex relative to its parent edge:
            //
            //  (We really need to encapsulate this somewhere else for use here and in the
            //  general case)
            //
            Vtr::IndexArray const vEdges = parent.getVertexEdges(vert);

            float   vVertWeight;
            float * vEdgeWeights = weightBuffer;
            float * vFaceWeights = vEdgeWeights + vEdges.size();

            Vtr::MaskInterface vMask(&vVertWeight, vEdgeWeights, vFaceWeights);

            vHood.SetIndex(vert, cVert);

            Sdc::Crease::Rule pRule = parent.getVertexRule(vert);
            Sdc::Crease::Rule cRule = child.getVertexRule(cVert);

            scheme.ComputeVertexVertexMask(vHood, vMask, pRule, cRule);

            //  Apply the weights to the parent vertex, the vertices opposite its incident
            //  edges, and the child vertices of its incident faces:
            //
            //  Even though the face-varying topology matches the vertex topology, we need
            //  to be careful here when getting values corresponding to vertices at the
            //  ends of edges.  While the edge may be continuous, the end vertex may have
            //  discontinuities elsewhere in their neighborhood (i.e. on the "other side"
            //  of the end-vertex) and so have sibling values associated with them.  In most
            //  cases the topology for an end-vertex will match and we can use it directly,
            //  but we must still check and retrieve as needed.
            //
            //  Indices for values corresponding to face-vertices are guaranteed to match,
            //  so we can use the child-vertex indices directly.
            //
            //  And by "directly", we always use getVertexValue(vertexIndex) to reference
            //  values in the "src" to account for the possible indirection that may exist at
            //  level 0 -- where there may be fewer values than vertices and an additional
            //  indirection is necessary.  We can use a vertex index directly for "dst" when
            //  it matches.
            //
            Vtr::Index pVertValue = parentFVar.getVertexValue(vert);
            Vtr::Index cVertValue = cVert;

            U & vdst = dst[cVertValue];

            vdst.Clear();
            vdst.AddWithWeight(src[pVertValue], vVertWeight);

            if (vMask.GetNumEdgeWeights() > 0) {

                //  WORK-IN-PROGRESS -- using this switch for comparative purposes only...
                bool assumeMatchingNeighborhood = false;
                if (assumeMatchingNeighborhood) {
                    for (int i = 0; i < vEdges.size(); ++i) {
                        Vtr::IndexArray const eVerts = parent.getEdgeVertices(vEdges[i]);
                        Vtr::Index pVertOppositeEdge = (eVerts[0] == vert) ? eVerts[1] : eVerts[0];

                        vdst.AddWithWeight(src[pVertOppositeEdge], vEdgeWeights[i]);
                    }
                } else {
                    parentFVar.getVertexEdgeValues(vert, vEdgeValues);

                    for (int i = 0; i < vEdges.size(); ++i) {
                        vdst.AddWithWeight(src[vEdgeValues[i]], vEdgeWeights[i]);
                    }
                }

            }
            if (vMask.GetNumFaceWeights() > 0) {

                Vtr::IndexArray const vFaces = parent.getVertexFaces(vert);

                for (int i = 0; i < vFaces.size(); ++i) {

                    Vtr::Index cVertOfFace = refinement.getFaceChildVertex(vFaces[i]);
                    assert(Vtr::IndexIsValid(cVertOfFace));
                    vdst.AddWithWeight(dst[cVertOfFace], vFaceWeights[i]);
                }
            }
        } else {
            //
            //  Mismatched vert-verts may be either on corners or creases -- for now we
            //  are presuming the hard-corner case (and so need to revisit this...)
            //
            for (int cSibling = 0; cSibling < childFVar.getNumVertexValues(cVert); ++cSibling) {
                int pSibling = refineFVar.getChildValueParentSource(cVert, cSibling);
                assert(pSibling == cSibling);

                Vtr::Index pVertValue = parentFVar.getVertexValue(vert, pSibling);
                Vtr::Index cVertValue = childFVar.getVertexValue(cVert, cSibling);

                U & vdst = dst[cVertValue];

                vdst.Clear();
                vdst.AddWithWeight(src[pVertValue], 1.0);
            }
        }
    }
}

template <class T, class U>
inline void
TopologyRefiner::Limit(T const * src, U * dst) const {

    //
    //  Work in progress...
    //      - does not support tangents yet (unclear how)
    //      - need to verify that each vertex is "limitable", i.e.:
    //          - is not semi-sharp, inf-sharp or non-manifold
    //          - is "complete" wrt its parent (if refinement is sparse)
    //      - copy (or weight by 1.0) src to dst when not "limitable"
    //      - currently requires one refinement to get rid of N-sided faces:
    //          - could limit regular vertices from level 0
    //

    assert(_subdivType == Sdc::TYPE_CATMARK);
    Sdc::Scheme<Sdc::TYPE_CATMARK> scheme(_subdivOptions);

    assert(GetMaxLevel() > 0);
    Vtr::Level const & level = _levels[GetMaxLevel()];

    int maxWeightsPerMask = 1 + 2 * level.getMaxValence();

    float * weightBuffer = (float *)alloca(maxWeightsPerMask * sizeof(float));

    //  This is a bit obscure -- assign both parent and child as last level
    Vtr::VertexInterface vHood(level, level);

    for (int vert = 0; vert < level.getNumVertices(); ++vert) {
        IndexArray const vEdges = level.getVertexEdges(vert);

        float * vWeights = weightBuffer,
              * eWeights = vWeights + 1,
              * fWeights = eWeights + vEdges.size();

        Vtr::MaskInterface vMask(vWeights, eWeights, fWeights);

        //  This is a bit obscure -- child vertex index will be ignored here
        vHood.SetIndex(vert, vert);

        scheme.ComputeVertexLimitMask(vHood, vMask);

        //  Apply the weights to the vertex, the vertices opposite its incident
        //  edges, and the opposite vertices of its incident faces:
        U & vdst = dst[vert];

        vdst.Clear();
        vdst.AddWithWeight(src[vert], vWeights[0]);

        if (vMask.GetNumEdgeWeights() > 0) {
            for (int i = 0; i < vEdges.size(); ++i) {
                IndexArray const eVerts = level.getEdgeVertices(vEdges[i]);
                Index vertOppositeEdge = (eVerts[0] == vert) ? eVerts[1] : eVerts[0];

                vdst.AddWithWeight(src[vertOppositeEdge], eWeights[i]);
            }
        }
        if (vMask.GetNumFaceWeights() > 0) {
            IndexArray const      vFaces = level.getVertexFaces(vert);
            LocalIndexArray const vInFace = level.getVertexFaceLocalIndices(vert);
            for (int i = 0; i < vFaces.size(); ++i) {
                LocalIndex vOppInFace = (vInFace[i] + 2) & 3;
                Index      vertOppositeFace = level.getFaceVertices(vFaces[i])[vOppInFace];

                vdst.AddWithWeight(src[vertOppositeFace], fWeights[i]);
            }
        }
    }
}

} // end namespace Far

} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;
} // end namespace OpenSubdiv

#endif /* FAR_TOPOLOGY_REFINER_H */