stencilTableFactory.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 OPENSUBDIV3_FAR_STENCILTABLE_FACTORY_H
#define OPENSUBDIV3_FAR_STENCILTABLE_FACTORY_H

#include "../version.h"

#include "../far/patchTable.h"

#include <vector>

namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {

namespace Far {

class TopologyRefiner;

template <typename REAL> class StencilReal;
template <typename REAL> class StencilTableReal;

template <typename REAL> class LimitStencilReal;
template <typename REAL> class LimitStencilTableReal;


template <typename REAL>
class StencilTableFactoryReal {

public:

    enum Mode {
        INTERPOLATE_VERTEX=0,           
        INTERPOLATE_VARYING,            
        INTERPOLATE_FACE_VARYING        
    };

    struct Options {

        Options() : interpolationMode(INTERPOLATE_VERTEX),
                    generateOffsets(false),
                    generateControlVerts(false),
                    generateIntermediateLevels(true),
                    factorizeIntermediateLevels(true),
                    maxLevel(10),
                    fvarChannel(0) { }

        unsigned int interpolationMode           : 2, 
                     generateOffsets             : 1, 
                     generateControlVerts        : 1, 
                     generateIntermediateLevels  : 1, 
                     factorizeIntermediateLevels : 1, 
                     maxLevel                    : 4; 
        unsigned int fvarChannel;                     
    };

    static StencilTableReal<REAL> const * Create(
                TopologyRefiner const & refiner, Options options = Options());


    static StencilTableReal<REAL> const * Create(
                int numTables, StencilTableReal<REAL> const ** tables);


    static StencilTableReal<REAL> const * AppendLocalPointStencilTable(
                TopologyRefiner const &refiner,
                StencilTableReal<REAL> const *baseStencilTable,
                StencilTableReal<REAL> const *localPointStencilTable,
                bool factorize = true);

    static StencilTableReal<REAL> const * AppendLocalPointStencilTableVarying(
                TopologyRefiner const &refiner,
                StencilTableReal<REAL> const *baseStencilTable,
                StencilTableReal<REAL> const *localPointStencilTable,
                bool factorize = true) {
        return AppendLocalPointStencilTable(
                refiner, baseStencilTable, localPointStencilTable, factorize);
    }

    static StencilTableReal<REAL> const * AppendLocalPointStencilTableFaceVarying(
                TopologyRefiner const &refiner,
                StencilTableReal<REAL> const *baseStencilTable,
                StencilTableReal<REAL> const *localPointStencilTable,
                int channel = 0,
                bool factorize = true);

private:

    // Generate stencils for the coarse control-vertices (single weight = 1.0f)
    static void generateControlVertStencils(
                int numControlVerts,
                StencilReal<REAL> & dst);

    // Internal method to splice local point stencils
    static StencilTableReal<REAL> const * appendLocalPointStencilTable(
                TopologyRefiner const &refiner,
                StencilTableReal<REAL> const * baseStencilTable,
                StencilTableReal<REAL> const * localPointStencilTable,
                int channel,
                bool factorize);
};

template <typename REAL>
class LimitStencilTableFactoryReal {

public:

    enum Mode {
        INTERPOLATE_VERTEX=0,           
        INTERPOLATE_VARYING,            
        INTERPOLATE_FACE_VARYING        
    };

    struct Options {

        Options() : interpolationMode(INTERPOLATE_VERTEX),
                    generate1stDerivatives(true),
                    generate2ndDerivatives(false),
                    fvarChannel(0) { }

        unsigned int interpolationMode           : 2, 
                     generate1stDerivatives      : 1, 
                     generate2ndDerivatives      : 1; 
        unsigned int fvarChannel;                     
    };

    struct LocationArray {

        LocationArray() : ptexIdx(-1), numLocations(0), s(0), t(0) { }

        int ptexIdx,        
            numLocations;   

        REAL  const * s,    
                    * t;    
    };

    typedef std::vector<LocationArray> LocationArrayVec;

    static LimitStencilTableReal<REAL> const * Create(
                TopologyRefiner const & refiner,
                LocationArrayVec const & locationArrays,
                StencilTableReal<REAL> const * cvStencils = 0,
                PatchTable const * patchTable = 0,
                Options options = Options());

};


//
//  Public wrapper classes for the templates
//
class Stencil;
class StencilTable;

class StencilTableFactory : public StencilTableFactoryReal<float> {
private:
    typedef StencilTableFactoryReal<float> BaseFactory;
    typedef StencilTableReal<float>        BaseTable;

public:
    static StencilTable const * Create(
                TopologyRefiner const & refiner, Options options = Options()) {

        return static_cast<StencilTable const *>(
                BaseFactory::Create(refiner, options));
    }

    static StencilTable const * Create(
                int numTables, StencilTable const ** tables) {

        return static_cast<StencilTable const *>(
                BaseFactory::Create(numTables,
                        reinterpret_cast<BaseTable const **>(tables)));
    }

    static StencilTable const * AppendLocalPointStencilTable(
                TopologyRefiner const &refiner,
                StencilTable const *baseStencilTable,
                StencilTable const *localPointStencilTable,
                bool factorize = true) {

        return static_cast<StencilTable const *>(
                BaseFactory::AppendLocalPointStencilTable(refiner,
                        static_cast<BaseTable const *>(baseStencilTable),
                        static_cast<BaseTable const *>(localPointStencilTable),
                        factorize));
    }

    static StencilTable const * AppendLocalPointStencilTableVarying(
                TopologyRefiner const &refiner,
                StencilTable const *baseStencilTable,
                StencilTable const *localPointStencilTable,
                bool factorize = true) {

        return static_cast<StencilTable const *>(
                BaseFactory::AppendLocalPointStencilTableVarying(refiner,
                        static_cast<BaseTable const *>(baseStencilTable),
                        static_cast<BaseTable const *>(localPointStencilTable),
                        factorize));
    }

    static StencilTable const * AppendLocalPointStencilTableFaceVarying(
                TopologyRefiner const &refiner,
                StencilTable const *baseStencilTable,
                StencilTable const *localPointStencilTable,
                int channel = 0,
                bool factorize = true) {

        return static_cast<StencilTable const *>(
                BaseFactory::AppendLocalPointStencilTableFaceVarying(refiner,
                        static_cast<BaseTable const *>(baseStencilTable),
                        static_cast<BaseTable const *>(localPointStencilTable),
                        channel, factorize));
    }
};

class LimitStencil;
class LimitStencilTable;

class LimitStencilTableFactory : public LimitStencilTableFactoryReal<float> {
private:
    typedef LimitStencilTableFactoryReal<float> BaseFactory;
    typedef StencilTableReal<float>             BaseTable;

public:
    static LimitStencilTable const * Create(
                TopologyRefiner const & refiner,
                LocationArrayVec const & locationArrays,
                StencilTable const * cvStencils = 0,
                PatchTable const * patchTable = 0,
                Options options = Options()) {

        return static_cast<LimitStencilTable const *>(
                BaseFactory::Create(
                        refiner,
                        locationArrays,
                        static_cast<BaseTable const *>(cvStencils),
                        patchTable,
                        options));
    }
};

} // end namespace Far

} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;

} // end namespace OpenSubdiv

#endif // OPENSUBDIV3_FAR_STENCILTABLE_FACTORY_H