mesh.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_MESH_H_INC
#define AI_MESH_H_INC

#include "types.h"

#ifdef __cplusplus
extern "C" {
#endif

// ---------------------------------------------------------------------------
// Limits. These values are required to match the settings Assimp was
// compiled against. Therefore, do not redefine them unless you build the
// library from source using the same definitions.
// ---------------------------------------------------------------------------

#ifndef AI_MAX_FACE_INDICES
#   define AI_MAX_FACE_INDICES 0x7fff
#endif

#ifndef AI_MAX_BONE_WEIGHTS
#   define AI_MAX_BONE_WEIGHTS 0x7fffffff
#endif

#ifndef AI_MAX_VERTICES
#   define AI_MAX_VERTICES 0x7fffffff
#endif

#ifndef AI_MAX_FACES
#   define AI_MAX_FACES 0x7fffffff
#endif

#ifndef AI_MAX_NUMBER_OF_COLOR_SETS
#   define AI_MAX_NUMBER_OF_COLOR_SETS 0x8
#endif // !! AI_MAX_NUMBER_OF_COLOR_SETS

#ifndef AI_MAX_NUMBER_OF_TEXTURECOORDS
#   define AI_MAX_NUMBER_OF_TEXTURECOORDS 0x8
#endif // !! AI_MAX_NUMBER_OF_TEXTURECOORDS

// ---------------------------------------------------------------------------
struct aiFace
{
    unsigned int mNumIndices;

    unsigned int* mIndices;

#ifdef __cplusplus

    aiFace()
      : mNumIndices( 0 )
      , mIndices( NULL )
    {
    }

    ~aiFace()
    {
        delete [] mIndices;
    }

    aiFace( const aiFace& o)
      : mIndices( NULL )
    {
        *this = o;
    }

    aiFace& operator = ( const aiFace& o)
    {
        if (&o == this)
            return *this;

        delete[] mIndices;
        mNumIndices = o.mNumIndices;
        if (mNumIndices) {
            mIndices = new unsigned int[mNumIndices];
            ::memcpy( mIndices, o.mIndices, mNumIndices * sizeof( unsigned int));
        }
        else {
            mIndices = NULL;
        }
        return *this;
    }

    bool operator== (const aiFace& o) const
    {
        if (mIndices == o.mIndices)return true;
        else if (mIndices && mNumIndices == o.mNumIndices)
        {
            for (unsigned int i = 0;i < this->mNumIndices;++i)
                if (mIndices[i] != o.mIndices[i])return false;
            return true;
        }
        return false;
    }

    bool operator != (const aiFace& o) const
    {
        return !(*this == o);
    }
#endif // __cplusplus
}; // struct aiFace


// ---------------------------------------------------------------------------
struct aiVertexWeight
{
    unsigned int mVertexId;

    float mWeight;

#ifdef __cplusplus

    aiVertexWeight() { }

    aiVertexWeight( unsigned int pID, float pWeight)
        : mVertexId( pID), mWeight( pWeight)
    { /* nothing to do here */ }

#endif // __cplusplus
};


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

    unsigned int mNumWeights;

    C_STRUCT aiVertexWeight* mWeights;

    C_STRUCT aiMatrix4x4 mOffsetMatrix;

#ifdef __cplusplus

    aiBone()
        : mName()
        , mNumWeights( 0 )
      , mWeights( NULL )
    {
    }

    aiBone(const aiBone& other)
      : mName( other.mName )
      , mNumWeights( other.mNumWeights )
      , mOffsetMatrix( other.mOffsetMatrix )
    {
        if (other.mWeights && other.mNumWeights)
        {
            mWeights = new aiVertexWeight[mNumWeights];
            ::memcpy(mWeights,other.mWeights,mNumWeights * sizeof(aiVertexWeight));
        }
    }

    ~aiBone()
    {
        delete [] mWeights;
    }
#endif // __cplusplus
};


// ---------------------------------------------------------------------------
enum aiPrimitiveType
{
    aiPrimitiveType_POINT       = 0x1,

    aiPrimitiveType_LINE        = 0x2,

    aiPrimitiveType_TRIANGLE    = 0x4,

    aiPrimitiveType_POLYGON     = 0x8,


#ifndef SWIG
    _aiPrimitiveType_Force32Bit = INT_MAX
#endif
}; 

// Get the #aiPrimitiveType flag for a specific number of face indices
#define AI_PRIMITIVE_TYPE_FOR_N_INDICES(n) \
    ((n) > 3 ? aiPrimitiveType_POLYGON : (aiPrimitiveType)(1u << ((n)-1)))



// ---------------------------------------------------------------------------
struct aiAnimMesh
{
    C_STRUCT aiVector3D* mVertices;

    C_STRUCT aiVector3D* mNormals;

    C_STRUCT aiVector3D* mTangents;

    C_STRUCT aiVector3D* mBitangents;

    C_STRUCT aiColor4D* mColors[AI_MAX_NUMBER_OF_COLOR_SETS];

    C_STRUCT aiVector3D* mTextureCoords[AI_MAX_NUMBER_OF_TEXTURECOORDS];

    unsigned int mNumVertices;
    
    float mWeight;

#ifdef __cplusplus

    aiAnimMesh()
        : mVertices( NULL )
        , mNormals( NULL )
        , mTangents( NULL )
        , mBitangents( NULL )
        , mNumVertices( 0 )
        , mWeight( 0.0f )
    {
        // fixme consider moving this to the ctor initializer list as well
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_TEXTURECOORDS; a++){
            mTextureCoords[a] = NULL;
        }
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_COLOR_SETS; a++) {
            mColors[a] = NULL;
        }
    }

    ~aiAnimMesh()
    {
        delete [] mVertices;
        delete [] mNormals;
        delete [] mTangents;
        delete [] mBitangents;
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_TEXTURECOORDS; a++) {
            delete [] mTextureCoords[a];
        }
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_COLOR_SETS; a++) {
            delete [] mColors[a];
        }
    }

    bool HasPositions() const {
        return mVertices != NULL;
    }

    bool HasNormals() const {
        return mNormals != NULL;
    }

    bool HasTangentsAndBitangents() const {
        return mTangents != NULL;
    }

    bool HasVertexColors( unsigned int pIndex) const    {
        return pIndex >= AI_MAX_NUMBER_OF_COLOR_SETS ? false : mColors[pIndex] != NULL;
    }

    bool HasTextureCoords( unsigned int pIndex) const   {
        return pIndex >= AI_MAX_NUMBER_OF_TEXTURECOORDS ? false : mTextureCoords[pIndex] != NULL;
    }

#endif
};

// ---------------------------------------------------------------------------
enum aiMorphingMethod
{
    aiMorphingMethod_VERTEX_BLEND       = 0x1,

    aiMorphingMethod_MORPH_NORMALIZED   = 0x2,

    aiMorphingMethod_MORPH_RELATIVE     = 0x3,

#ifndef SWIG
    _aiMorphingMethod_Force32Bit = INT_MAX
#endif
}; 

// ---------------------------------------------------------------------------
struct aiMesh
{
    unsigned int mPrimitiveTypes;

    unsigned int mNumVertices;

    unsigned int mNumFaces;

    C_STRUCT aiVector3D* mVertices;

    C_STRUCT aiVector3D* mNormals;

    C_STRUCT aiVector3D* mTangents;

    C_STRUCT aiVector3D* mBitangents;

    C_STRUCT aiColor4D* mColors[AI_MAX_NUMBER_OF_COLOR_SETS];

    C_STRUCT aiVector3D* mTextureCoords[AI_MAX_NUMBER_OF_TEXTURECOORDS];

    unsigned int mNumUVComponents[AI_MAX_NUMBER_OF_TEXTURECOORDS];

    C_STRUCT aiFace* mFaces;

    unsigned int mNumBones;

    C_STRUCT aiBone** mBones;

    unsigned int mMaterialIndex;

    C_STRUCT aiString mName;


    unsigned int mNumAnimMeshes;

    C_STRUCT aiAnimMesh** mAnimMeshes;

    unsigned int mMethod;
    
#ifdef __cplusplus

    aiMesh()
        : mPrimitiveTypes( 0 )
        , mNumVertices( 0 )
        , mNumFaces( 0 )
        , mVertices( NULL )
        , mNormals( NULL )
        , mTangents( NULL )
        , mBitangents( NULL )
        , mFaces( NULL )
        , mNumBones( 0 )
        , mBones( NULL )
        , mMaterialIndex( 0 )
        , mNumAnimMeshes( 0 )
        , mAnimMeshes( NULL )
        , mMethod( 0 )
    {
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_TEXTURECOORDS; a++)
        {
            mNumUVComponents[a] = 0;
            mTextureCoords[a] = NULL;
        }

        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_COLOR_SETS; a++)
            mColors[a] = NULL;
    }

    ~aiMesh()
    {
        delete [] mVertices;
        delete [] mNormals;
        delete [] mTangents;
        delete [] mBitangents;
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_TEXTURECOORDS; a++) {
            delete [] mTextureCoords[a];
        }
        for( unsigned int a = 0; a < AI_MAX_NUMBER_OF_COLOR_SETS; a++) {
            delete [] mColors[a];
        }

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

        if (mNumAnimMeshes && mAnimMeshes)  {
            for( unsigned int a = 0; a < mNumAnimMeshes; a++) {
                delete mAnimMeshes[a];
            }
            delete [] mAnimMeshes;
        }

        delete [] mFaces;
    }

    bool HasPositions() const
        { return mVertices != NULL && mNumVertices > 0; }

    bool HasFaces() const
        { return mFaces != NULL && mNumFaces > 0; }

    bool HasNormals() const
        { return mNormals != NULL && mNumVertices > 0; }

    bool HasTangentsAndBitangents() const
        { return mTangents != NULL && mBitangents != NULL && mNumVertices > 0; }

    bool HasVertexColors( unsigned int pIndex) const
    {
        if( pIndex >= AI_MAX_NUMBER_OF_COLOR_SETS)
            return false;
        else
            return mColors[pIndex] != NULL && mNumVertices > 0;
    }

    bool HasTextureCoords( unsigned int pIndex) const
    {
        if( pIndex >= AI_MAX_NUMBER_OF_TEXTURECOORDS)
            return false;
        else
            return mTextureCoords[pIndex] != NULL && mNumVertices > 0;
    }

    unsigned int GetNumUVChannels() const
    {
        unsigned int n = 0;
        while (n < AI_MAX_NUMBER_OF_TEXTURECOORDS && mTextureCoords[n])++n;
        return n;
    }

    unsigned int GetNumColorChannels() const
    {
        unsigned int n = 0;
        while (n < AI_MAX_NUMBER_OF_COLOR_SETS && mColors[n])++n;
        return n;
    }

    inline bool HasBones() const
        { return mBones != NULL && mNumBones > 0; }

#endif // __cplusplus
};

#ifdef __cplusplus
}
#endif 
#endif // AI_MESH_H_INC