anim.h

Go to the documentation of this file.

/*
---------------------------------------------------------------------------
Open Asset Import Library (assimp)
---------------------------------------------------------------------------

Copyright (c) 2006-2017, assimp team


All rights reserved.

Redistribution and use of this software 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 the assimp team, nor the names of its
  contributors may be used to endorse or promote products
  derived from this software without specific prior
  written permission of the assimp team.

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.
---------------------------------------------------------------------------
*/

#pragma once
#ifndef AI_ANIM_H_INC
#define AI_ANIM_H_INC

#include <assimp/types.h>
#include <assimp/quaternion.h>

#ifdef __cplusplus
extern "C" {
#endif

// ---------------------------------------------------------------------------
struct aiVectorKey
{
    double mTime;

    C_STRUCT aiVector3D mValue;

#ifdef __cplusplus

    aiVectorKey() 
    : mTime( 0.0 )
    , mValue() {
        // empty
    }


    aiVectorKey(double time, const aiVector3D& value)
        :   mTime   (time)
        ,   mValue  (value)
    {}

    typedef aiVector3D elem_type;

    // Comparison operators. For use with std::find();
    bool operator == (const aiVectorKey& o) const {
        return o.mValue == this->mValue;
    }
    bool operator != (const aiVectorKey& o) const {
        return o.mValue != this->mValue;
    }

    // Relational operators. For use with std::sort();
    bool operator < (const aiVectorKey& o) const {
        return mTime < o.mTime;
    }
    bool operator > (const aiVectorKey& o) const {
        return mTime > o.mTime;
    }
#endif // __cplusplus
};

// ---------------------------------------------------------------------------
struct aiQuatKey
{
    double mTime;

    C_STRUCT aiQuaternion mValue;

#ifdef __cplusplus
    aiQuatKey()
    : mTime( 0.0 )
    , mValue() {
        // empty
    }

    aiQuatKey(double time, const aiQuaternion& value)
        :   mTime   (time)
        ,   mValue  (value)
    {}

    typedef aiQuaternion elem_type;

    // Comparison operators. For use with std::find();
    bool operator == (const aiQuatKey& o) const {
        return o.mValue == this->mValue;
    }
    bool operator != (const aiQuatKey& o) const {
        return o.mValue != this->mValue;
    }

    // Relational operators. For use with std::sort();
    bool operator < (const aiQuatKey& o) const {
        return mTime < o.mTime;
    }
    bool operator > (const aiQuatKey& o) const {
        return mTime > o.mTime;
    }
#endif
};

// ---------------------------------------------------------------------------
struct aiMeshKey
{
    double mTime;

    unsigned int mValue;

#ifdef __cplusplus

    aiMeshKey() {
    }

    aiMeshKey(double time, const unsigned int value)
        :   mTime   (time)
        ,   mValue  (value)
    {}

    typedef unsigned int elem_type;

    // Comparison operators. For use with std::find();
    bool operator == (const aiMeshKey& o) const {
        return o.mValue == this->mValue;
    }
    bool operator != (const aiMeshKey& o) const {
        return o.mValue != this->mValue;
    }

    // Relational operators. For use with std::sort();
    bool operator < (const aiMeshKey& o) const {
        return mTime < o.mTime;
    }
    bool operator > (const aiMeshKey& o) const {
        return mTime > o.mTime;
    }

#endif
};

// ---------------------------------------------------------------------------
struct aiMeshMorphKey
{
    double mTime;

    unsigned int *mValues;
    double *mWeights;

    unsigned int mNumValuesAndWeights;
#ifdef __cplusplus
    aiMeshMorphKey()
        : mTime(0.0)
        , mValues(NULL)
        , mWeights(NULL)
        , mNumValuesAndWeights(0)
    {

    }

    ~aiMeshMorphKey()
    {
        if (mNumValuesAndWeights && mValues && mWeights) {
            delete [] mValues;
            delete [] mWeights;
        }
    }
#endif
};

// ---------------------------------------------------------------------------
enum aiAnimBehaviour
{
    aiAnimBehaviour_DEFAULT  = 0x0,

    aiAnimBehaviour_CONSTANT = 0x1,

    aiAnimBehaviour_LINEAR   = 0x2,

    aiAnimBehaviour_REPEAT   = 0x3,

#ifndef SWIG
    _aiAnimBehaviour_Force32Bit = INT_MAX
#endif
};

// ---------------------------------------------------------------------------
struct aiNodeAnim {
    C_STRUCT aiString mNodeName;

    unsigned int mNumPositionKeys;

    C_STRUCT aiVectorKey* mPositionKeys;

    unsigned int mNumRotationKeys;

    C_STRUCT aiQuatKey* mRotationKeys;

    unsigned int mNumScalingKeys;

    C_STRUCT aiVectorKey* mScalingKeys;

    C_ENUM aiAnimBehaviour mPreState;

    C_ENUM aiAnimBehaviour mPostState;

#ifdef __cplusplus
    aiNodeAnim() 
    : mNumPositionKeys( 0 )
    , mPositionKeys( NULL )
    , mNumRotationKeys( 0 )
    , mRotationKeys( NULL )
    , mNumScalingKeys( 0 )
    , mScalingKeys( NULL )
    , mPreState( aiAnimBehaviour_DEFAULT )
    , mPostState( aiAnimBehaviour_DEFAULT ) {
         // empty
    }

    ~aiNodeAnim() {
        delete [] mPositionKeys;
        delete [] mRotationKeys;
        delete [] mScalingKeys;
    }
#endif // __cplusplus
};

// ---------------------------------------------------------------------------
struct aiMeshAnim
{
    C_STRUCT aiString mName;

    unsigned int mNumKeys;

    C_STRUCT aiMeshKey* mKeys;

#ifdef __cplusplus

    aiMeshAnim()
        : mNumKeys()
        , mKeys()
    {}

    ~aiMeshAnim()
    {
        delete[] mKeys;
    }

#endif
};

// ---------------------------------------------------------------------------
struct aiMeshMorphAnim
{
    C_STRUCT aiString mName;

    unsigned int mNumKeys;

    C_STRUCT aiMeshMorphKey* mKeys;

#ifdef __cplusplus

    aiMeshMorphAnim()
        : mNumKeys()
        , mKeys()
    {}

    ~aiMeshMorphAnim()
    {
        delete[] mKeys;
    }

#endif
};

// ---------------------------------------------------------------------------
struct aiAnimation {
    C_STRUCT aiString mName;

    double mDuration;

    double mTicksPerSecond;

    unsigned int mNumChannels;

    C_STRUCT aiNodeAnim** mChannels;


    unsigned int mNumMeshChannels;

    C_STRUCT aiMeshAnim** mMeshChannels;

    unsigned int mNumMorphMeshChannels;

    C_STRUCT aiMeshMorphAnim **mMorphMeshChannels;

#ifdef __cplusplus
    aiAnimation()
    : mDuration(-1.)
    , mTicksPerSecond(0.)
    , mNumChannels(0)
    , mChannels(NULL)
    , mNumMeshChannels(0)
    , mMeshChannels(NULL)
    , mNumMorphMeshChannels(0)
    , mMorphMeshChannels(NULL) {
        // empty
    }

    ~aiAnimation() {
        // DO NOT REMOVE THIS ADDITIONAL CHECK
        if ( mNumChannels && mChannels )  {
            for( unsigned int a = 0; a < mNumChannels; a++) {
                delete mChannels[ a ];
            }

            delete [] mChannels;
        }
        if (mNumMeshChannels && mMeshChannels)  {
            for( unsigned int a = 0; a < mNumMeshChannels; a++) {
                delete mMeshChannels[a];
            }

            delete [] mMeshChannels;
        }
        if (mNumMorphMeshChannels && mMorphMeshChannels) {
                for( unsigned int a = 0; a < mNumMorphMeshChannels; a++) {
                        delete mMorphMeshChannels[a];
                }
            
            delete [] mMorphMeshChannels;
        }
    }
#endif // __cplusplus
};

#ifdef __cplusplus

}

namespace Assimp {

// ---------------------------------------------------------------------------
template <typename T>
struct Interpolator
{
    // ------------------------------------------------------------------
    void operator () (T& out,const T& a, const T& b, ai_real d) const {
        out = a + (b-a)*d;
    }
}; // ! Interpolator <T>


template <>
struct Interpolator <aiQuaternion>  {
    void operator () (aiQuaternion& out,const aiQuaternion& a,
        const aiQuaternion& b, ai_real d) const
    {
        aiQuaternion::Interpolate(out,a,b,d);
    }
}; // ! Interpolator <aiQuaternion>

template <>
struct Interpolator <unsigned int>  {
    void operator () (unsigned int& out,unsigned int a,
        unsigned int b, ai_real d) const
    {
        out = d>0.5f ? b : a;
    }
}; // ! Interpolator <aiQuaternion>

template <>
struct Interpolator<aiVectorKey>  {
    void operator () (aiVector3D& out,const aiVectorKey& a,
        const aiVectorKey& b, ai_real d) const
    {
        Interpolator<aiVector3D> ipl;
        ipl(out,a.mValue,b.mValue,d);
    }
}; // ! Interpolator <aiVectorKey>

template <>
struct Interpolator<aiQuatKey>  {
    void operator () (aiQuaternion& out, const aiQuatKey& a,
        const aiQuatKey& b, ai_real d) const
    {
        Interpolator<aiQuaternion> ipl;
        ipl(out,a.mValue,b.mValue,d);
    }
}; // ! Interpolator <aiQuatKey>

template <>
struct Interpolator<aiMeshKey>     {
    void operator () (unsigned int& out, const aiMeshKey& a,
        const aiMeshKey& b, ai_real d) const
    {
        Interpolator<unsigned int> ipl;
        ipl(out,a.mValue,b.mValue,d);
    }
}; // ! Interpolator <aiQuatKey>


} //  ! end namespace Assimp

#endif // __cplusplus

#endif // AI_ANIM_H_INC