//-*****************************************************************************

//

// Copyright (c) 2009-2012,

//  Sony Pictures Imageworks Inc. and

//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.

//

// All rights reserved.

//

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

// *       Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

// *       Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

// *       Neither the name of Sony Pictures Imageworks, nor

// Industrial Light & Magic, nor the names of their contributors may be used

// to endorse or promote products derived from this software without specific

// prior written permission.

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//

//-*****************************************************************************

#ifndef Alembic_AbcGeom_INuPatch_h

#define Alembic_AbcGeom_INuPatch_h

#include <Alembic/Util/Export.h>

#include <Alembic/AbcGeom/Foundation.h>

#include <Alembic/AbcGeom/SchemaInfoDeclarations.h>

#include <Alembic/AbcGeom/IGeomParam.h>

#include <Alembic/AbcGeom/IGeomBase.h>

namespace Alembic {

namespace AbcGeom {

namespace ALEMBIC_VERSION_NS {

//-*****************************************************************************

class ALEMBIC_EXPORT INuPatchSchema : public IGeomBaseSchema<NuPatchSchemaInfo>

{

public:

    class Sample

    {

    public:

        typedef Sample this_type;

        // Users don't ever create this data directly.

        Sample() { reset(); }

        Abc::P3fArraySamplePtr getPositions() const { return m_positions; }

        Abc::V3fArraySamplePtr getVelocities() const { return m_velocities; }

        int32_t getNumU() const { return m_numU; }

        int32_t getNumV() const { return m_numV; }

        int32_t getUOrder() const { return m_uOrder; }

        int32_t getVOrder() const { return m_vOrder; }

        Abc::FloatArraySamplePtr getUKnot() const { return m_uKnot; }

        Abc::FloatArraySamplePtr getVKnot() const { return m_vKnot; }

        // if this is NULL then the weight value of the position for each

        // point is 1

        Abc::FloatArraySamplePtr getPositionWeights() const { return m_positionWeights; }

        // trim curve

        int32_t getTrimNumLoops() const { return m_trimNumLoops; }

        Abc::Int32ArraySamplePtr getTrimNumVertices() const { return m_trimNumVertices; }

        Abc::Int32ArraySamplePtr getTrimNumCurves() const { return m_trimNumCurves; }

        Abc::Int32ArraySamplePtr getTrimOrders() const { return m_trimOrder; }

        Abc::FloatArraySamplePtr getTrimKnots() const { return m_trimKnot; }

        Abc::FloatArraySamplePtr getTrimMins() const { return m_trimMin; }

        Abc::FloatArraySamplePtr getTrimMaxes() const { return m_trimMax; }

        Abc::FloatArraySamplePtr getTrimU() const { return m_trimU; }

        Abc::FloatArraySamplePtr getTrimV() const { return m_trimV; }

        Abc::FloatArraySamplePtr getTrimW() const { return m_trimW; }

        bool hasTrimCurve() const { return m_trimNumLoops != 0; }

        bool valid() const

        {

            return m_positions && m_numU && m_numV && m_uOrder && m_vOrder &&

                m_uKnot && m_vKnot;

        }

        Abc::Box3d getSelfBounds() const { return m_selfBounds; }

        void reset()

        {

            m_positions.reset();

            m_velocities.reset();

            m_numU = 0;

            m_numV = 0;

            m_uOrder = 0;

            m_vOrder = 0;

            m_uKnot.reset();

            m_vKnot.reset();

            m_positionWeights.reset();

            m_selfBounds.makeEmpty();

            // trim curve

            m_trimNumLoops = 0;

            m_trimNumCurves.reset();

            m_trimNumVertices.reset();

            m_trimOrder.reset();

            m_trimKnot.reset();

            m_trimMin.reset();

            m_trimMax.reset();

            m_trimU.reset();

            m_trimV.reset();

            m_trimW.reset();

        }

        ALEMBIC_OPERATOR_BOOL( valid() );

    protected:

        friend class INuPatchSchema;

        Abc::P3fArraySamplePtr m_positions;

        Abc::V3fArraySamplePtr m_velocities;

        int32_t m_numU;

        int32_t m_numV;

        int32_t m_uOrder;

        int32_t m_vOrder;

        Abc::FloatArraySamplePtr m_uKnot;

        Abc::FloatArraySamplePtr m_vKnot;

        Abc::FloatArraySamplePtr m_positionWeights;

        // trim curve

        int32_t m_trimNumLoops;

        Abc::Int32ArraySamplePtr m_trimNumCurves;

        Abc::Int32ArraySamplePtr m_trimNumVertices;

        Abc::Int32ArraySamplePtr m_trimOrder;

        Abc::FloatArraySamplePtr m_trimKnot;

        Abc::FloatArraySamplePtr m_trimMin;

        Abc::FloatArraySamplePtr m_trimMax;

        Abc::FloatArraySamplePtr m_trimU;

        Abc::FloatArraySamplePtr m_trimV;

        Abc::FloatArraySamplePtr m_trimW;

        bool m_hasTrimCurve;

        // bounds

        Abc::Box3d m_selfBounds;

    };

    //-*************************************************************************

    // NuPatch Schema

    //-*************************************************************************

public:

    //! By convention we always define this_type in AbcGeom classes.

    //! Used by unspecified-bool-type conversion below

    typedef INuPatchSchema this_type;

    typedef Sample sample_type;

    //-*************************************************************************

    // CONSTRUCTION, DESTRUCTION, ASSIGNMENT

    //-*************************************************************************

    //! The default constructor

    INuPatchSchema()

    {

        m_hasTrimCurve = false;

    }

    //! This constructor creates a new nurbs patch reader.

    //! The first argument is the parent ICompoundProperty, from which the

    //! error handler policy for is derived.  The second argument is the name

    //! of the ICompoundProperty that contains this schemas properties.  The

    //! remaining optional arguments can be used to override the

    //! ErrorHandlerPolicy and to specify schema interpretation matching.

    INuPatchSchema( const ICompoundProperty &iParent,

                    const std::string &iName,

                    const Abc::Argument &iArg0 = Abc::Argument(),

                    const Abc::Argument &iArg1 = Abc::Argument() )

      : IGeomBaseSchema<NuPatchSchemaInfo>( iParent, iName, iArg0, iArg1 )

    {

        init( iArg0, iArg1 );

    }

    //! This constructor wraps an existing ICompoundProperty as the nurbs

    //! reader, and the error handler policy is derived from it.

    //! The  remaining optional arguments can be used to override the

    //! ErrorHandlerPolicy and to specify schema interpretation matching.

    explicit INuPatchSchema( const ICompoundProperty &iProp,

                             const Abc::Argument &iArg0 = Abc::Argument(),

                             const Abc::Argument &iArg1 = Abc::Argument() )

      : IGeomBaseSchema<NuPatchSchemaInfo>( iProp, iArg0, iArg1 )

    {

        init( iArg0, iArg1 );

    }

    //! Return the number of samples contained in the property.

    //! This can be any number, including zero.

    //! This returns the number of samples that were written, independently

    //! of whether or not they were constant.

    size_t getNumSamples() const

    { return m_positionsProperty.getNumSamples(); }

    //! Return the topological variance.

    //! This indicates how the mesh may change.

    MeshTopologyVariance getTopologyVariance() const;

    //! Ask if we're constant - no change in value amongst samples,

    //! regardless of the time sampling.

    bool isConstant() const { return getTopologyVariance() == kConstantTopology; }

    //! Time information.

    AbcA::TimeSamplingPtr getTimeSampling() const

    {

        return m_positionsProperty.getTimeSampling();

    }

    void get( sample_type &oSample,

              const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const;

    Sample getValue( const Abc::ISampleSelector &iSS = Abc::ISampleSelector() ) const

    {

        Sample smp;

        get( smp, iSS );

        return smp;

    }

    Abc::IP3fArrayProperty getPositionsProperty() const { return m_positionsProperty; }

    Abc::IFloatArrayProperty getUKnotsProperty() const { return m_uKnotProperty; }

    Abc::IFloatArrayProperty getVKnotsProperty() const { return m_vKnotProperty; }

    Abc::IV3fArrayProperty getVelocitiesProperty() const

    {

        return m_velocitiesProperty;

    }

    // if this property is invalid then the weight for every point is 1

    Abc::IFloatArrayProperty getPositionWeightsProperty() const

    {

        return m_positionWeightsProperty;

    }

    IN3fGeomParam getNormalsParam() const

    {

        return m_normalsParam;

    }

    IV2fGeomParam getUVsParam() const

    {

        return m_uvsParam;

    }

    bool hasTrimCurve() const { return m_hasTrimCurve; }

    bool trimCurveTopologyIsHomogenous() const;

    bool trimCurveTopologyIsConstant() const;

    //-*************************************************************************

    // ABC BASE MECHANISMS

    // These functions are used by Abc to deal with errors, rewrapping,

    // and so on.

    //-*************************************************************************

    //! Reset returns this function set to an empty, default

    //! state.

    void reset()

    {

        m_positionsProperty.reset();

        m_velocitiesProperty.reset();

        m_numUProperty.reset();

        m_numVProperty.reset();

        m_uOrderProperty.reset();

        m_vOrderProperty.reset();

        m_uKnotProperty.reset();

        m_vKnotProperty.reset();

        m_positionWeightsProperty.reset();

        m_normalsParam.reset();

        m_uvsParam.reset();

        // reset trim curve attributes

        m_trimNumLoopsProperty.reset();

        m_trimNumCurvesProperty.reset();

        m_trimNumVerticesProperty.reset();

        m_trimOrderProperty.reset();

        m_trimKnotProperty.reset();

        m_trimMinProperty.reset();

        m_trimMaxProperty.reset();

        m_trimUProperty.reset();

        m_trimVProperty.reset();

        m_trimWProperty.reset();

        IGeomBaseSchema<NuPatchSchemaInfo>::reset();

    }

    //! Valid returns whether this function set is

    //! valid.

    bool valid() const

    {

        return ( IGeomBaseSchema<NuPatchSchemaInfo>::valid() &&

                 m_positionsProperty.valid() &&

                 m_numUProperty.valid() &&

                 m_numVProperty.valid() &&

                 m_uOrderProperty.valid() &&

                 m_vOrderProperty.valid() &&

                 m_uKnotProperty.valid() &&

                 m_vKnotProperty.valid() );

    }

    //! unspecified-bool-type operator overload.

    //! ...

    ALEMBIC_OVERRIDE_OPERATOR_BOOL( INuPatchSchema::valid() );

protected:

    bool hasTrimProps() const;

protected:

    void init( const Abc::Argument &iArg0,

               const Abc::Argument &iArg1 );

    // required properties

    Abc::IP3fArrayProperty m_positionsProperty;

    Abc::IInt32Property m_numUProperty;

    Abc::IInt32Property m_numVProperty;

    Abc::IInt32Property m_uOrderProperty;

    Abc::IInt32Property m_vOrderProperty;

    Abc::IFloatArrayProperty m_uKnotProperty;

    Abc::IFloatArrayProperty m_vKnotProperty;

    // optional

    Abc::IV3fArrayProperty m_velocitiesProperty;

    Abc::IFloatArrayProperty m_positionWeightsProperty;

    IN3fGeomParam m_normalsParam;

    IV2fGeomParam m_uvsParam;

    // optional trim curve properties

    Abc::IInt32Property m_trimNumLoopsProperty;

    Abc::IInt32ArrayProperty m_trimNumVerticesProperty;

    Abc::IInt32ArrayProperty m_trimNumCurvesProperty;

    Abc::IInt32ArrayProperty m_trimOrderProperty;

    Abc::IFloatArrayProperty m_trimKnotProperty;

    Abc::IFloatArrayProperty m_trimMinProperty;

    Abc::IFloatArrayProperty m_trimMaxProperty;

    Abc::IFloatArrayProperty m_trimUProperty;

    Abc::IFloatArrayProperty m_trimVProperty;

    Abc::IFloatArrayProperty m_trimWProperty;

    bool m_hasTrimCurve;

};

//-*****************************************************************************

typedef Abc::ISchemaObject<INuPatchSchema> INuPatch;

typedef Util::shared_ptr< INuPatch > INuPatchPtr;

} // End namespace ALEMBIC_VERSION_NS

using namespace ALEMBIC_VERSION_NS;

} // End namespace AbcGeom

} // End namespace Alembic

#endif