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

//

// 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_Foundation_h

#define Alembic_AbcGeom_Foundation_h

#include <Alembic/Abc/All.h>

#include <ImathMatrixAlgo.h>

#include <ImathEuler.h>

namespace Alembic {

namespace AbcGeom {

namespace ALEMBIC_VERSION_NS {

namespace Abc = ::Alembic::Abc::ALEMBIC_VERSION_NS;

using namespace Abc;

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

//! Meshes have topology, which can be either unchanging (constant)

//! homogeneous, which indicates that the connectivity is unchanging,

//! but the positions may change, and finally heterogeneous, which indicates

//! that the connectivity and positions may change.

enum MeshTopologyVariance

{

    kConstantTopology = 0,

    kHomogenousTopology = 1,

    kHomogeneousTopology = 1,

    kHeterogenousTopology = 2,

    kHeterogeneousTopology = 2

};

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

//! \brief Enum that indicates the type of transformational operation.

//! This enum is used when encoding and decoding the transform operation data.

enum XformOperationType

{

    kScaleOperation = 0,

    kTranslateOperation = 1,

    kRotateOperation = 2,

    kMatrixOperation = 3,

    kRotateXOperation = 4,

    kRotateYOperation = 5,

    kRotateZOperation = 6

};

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

//! \brief Enum that indicates the type of 2d operation for cameras.

//! This enum is used when encoding and decoding the 2d filmback data for

//! cameras.

enum FilmBackXformOperationType

{

    kScaleFilmBackOperation = 0,

    kTranslateFilmBackOperation = 1,

    kMatrixFilmBackOperation = 2

};

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

//! This utility function sets an array prorperty sample using "set" if

//! the sample is non-null, otherwise calls setFromPrevious.

template <class PROP, class SAMP>

inline void SetPropUsePrevIfNull( PROP iProp, SAMP iSamp )

{

    if ( iProp )

    {

        // really only valid with array properties

        assert( iProp.isArray() );

        if ( iSamp ) { iProp.set( iSamp ); }

        else { iProp.setFromPrevious(); }

    }

}

template <>

inline void SetPropUsePrevIfNull<Abc::OStringProperty, std::string>(

    Abc::OStringProperty iProp, std::string iSamp )

{

    if ( ! iProp ) { return; }

    if ( iSamp != "" ) { iProp.set( iSamp ); }

    else { iProp.setFromPrevious(); }

}

template <>

inline void SetPropUsePrevIfNull<Abc::OWstringProperty, Alembic::Util::wstring>(

    Abc::OWstringProperty iProp, Alembic::Util::wstring iSamp )

{

    if ( ! iProp ) { return; }

    if ( iSamp != L"" ) { iProp.set( iSamp ); }

    else { iProp.setFromPrevious(); }

}

template <>

inline void SetPropUsePrevIfNull<Abc::OBox3dProperty, Abc::Box3d>(

    Abc::OBox3dProperty iProp, Abc::Box3d iSamp )

{

    if ( ! iProp ) { return; }

    if ( iSamp.hasVolume() ) { iProp.set( iSamp ); }

    else { iProp.setFromPrevious(); }

}

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

//! This utility function computes an axis-aligned bounding box from a

//! positions sample

template <class ARRAYSAMP>

static Abc::Box3d ComputeBoundsFromPositions( const ARRAYSAMP &iSamp )

{

    Abc::Box3d ret;

    size_t size = iSamp.size();

    for ( size_t i = 0 ; i < size ; ++i )

    {

        ret.extendBy( iSamp[i] );

    }

    return ret;

}

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

//! used in xform rotation conversion

inline double DegreesToRadians( double iDegrees )

{

    return ( iDegrees * M_PI ) / 180.0;

}

inline double RadiansToDegrees( double iRadians )

{

    return iRadians * ( 180.0 / M_PI );

}

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

//! A couple simple tests for if something is a GeomParam

inline bool IsGeomParam( const AbcA::PropertyHeader &iHeader )

{

    return iHeader.isArray() || ( iHeader.isCompound() &&

        iHeader.getMetaData().get( "podName" ) != "" &&

        iHeader.getMetaData().get( "podExtent" ) != "" );

}

} // End namespace ALEMBIC_VERSION_NS

using namespace ALEMBIC_VERSION_NS;

} // End namespace AbcGeom

} // End namespace Alembic

#endif