//
//   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_FACTORY_H
#define FAR_PATCH_TABLES_FACTORY_H

#include "../version.h"

#include "../far/patchTables.h"

namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {

//  Forward declarations (for internal implementation purposes):
namespace Vtr { class Level; }

namespace Far {

class StencilTables;
class TopologyRefiner;

template <typename T> struct PatchTypes;
struct PatchFaceTag;


/// \brief A specialized factory for feature adaptive PatchTables
///
/// PatchTables contain the lists of vertices for each patch of an adaptive
/// mesh representation.
///
class PatchTablesFactory {

public:

    struct Options {

        Options(unsigned int maxIsolationLevel=10) :
             generateAllLevels(false),
             triangulateQuads(false),
             generateFVarTables(false),
             useSingleCreasePatch(false),
             maxIsolationLevel(maxIsolationLevel),
             adaptiveStencilTables(0) { }

        unsigned int generateAllLevels : 1,    ///< Include levels from 'firstLevel' to 'maxLevel' (Uniform mode only)
                     triangulateQuads  : 1,    ///< Triangulate 'QUADS' primitives (Uniform mode only)
                     generateFVarTables : 1,   ///< Generate face-varying patch tables
                     useSingleCreasePatch : 1, ///< Use single crease patch
                     maxIsolationLevel : 4;    ///< Cap the sharpnness of single creased patches to be consistent to other feature isolations.

        StencilTables const * adaptiveStencilTables;
    };

    /// \brief Factory constructor for PatchTables
    ///
    /// @param refiner  TopologyRefiner from which to generate patches
    ///
    /// @param options       Options controlling the creation of the tables
    ///
    /// @return              A new instance of PatchTables
    ///
    static PatchTables * Create(TopologyRefiner const & refiner, Options options=Options());

private:

    typedef PatchTables::FVarPatchTables FVarPatchTables;

    static PatchTables * createUniform( TopologyRefiner const & refiner, Options options );

    static PatchTables * createAdaptive( TopologyRefiner const & refiner, Options options );

    //  High-level methods for identifying and populating patches associated with faces:
    static void identifyAdaptivePatches( TopologyRefiner const & refiner,
                                         PatchTypes<int> & patchInventory,
                                         std::vector<PatchFaceTag> & patchTags,
                                         Options options );

    static void populateAdaptivePatches( TopologyRefiner const & refiner,
                                         PatchTypes<int> const & patchInventory,
                                         std::vector<PatchFaceTag> const & patchTags,
                                         PatchTables * tables,
                                         Options options );

    //  Methods for allocating and managing the patch table data arrays:
    static void allocateTables( PatchTables * tables, int nlevels, bool hasSharpness );

    static FVarPatchTables * allocateFVarTables( TopologyRefiner const & refiner,
                                                 PatchTables const & tables,
                                                 Options options );

    static PatchParam * computePatchParam( TopologyRefiner const & refiner, int level,
                                           int face, int rotation, PatchParam * coord );

    static void getQuadOffsets(Vtr::Level const & level, int face, unsigned int * result);

    static int assignSharpnessIndex( PatchTables *tables, float sharpness );

private:
};

} // end namespace Far

} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;

} // end namespace OpenSubdiv

#endif /* FAR_PATCH_TABLES_FACTORY_H */