types.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_TYPES_H_INC
#define AI_TYPES_H_INC

// Some runtime headers
#include <sys/types.h>
#include <stddef.h>
#include <string.h>
#include <limits.h>

// Our compile configuration
#include "defs.h"

// Some types moved to separate header due to size of operators
#include "vector3.h"
#include "vector2.h"
#include "color4.h"
#include "matrix3x3.h"
#include "matrix4x4.h"
#include "quaternion.h"

#ifdef __cplusplus
#include <cstring>
#include <new>      // for std::nothrow_t
#include <string>   // for aiString::Set(const std::string&)

namespace Assimp    {
namespace Intern        {
    // --------------------------------------------------------------------
    // --------------------------------------------------------------------
#ifndef SWIG
    struct ASSIMP_API AllocateFromAssimpHeap    {
        // http://www.gotw.ca/publications/mill15.htm

        // new/delete overload
        void *operator new    ( size_t num_bytes) /* throw( std::bad_alloc ) */;
        void *operator new    ( size_t num_bytes, const std::nothrow_t& ) throw();
        void  operator delete ( void* data);

        // array new/delete overload
        void *operator new[]    ( size_t num_bytes) /* throw( std::bad_alloc ) */;
        void *operator new[]    ( size_t num_bytes, const std::nothrow_t& )  throw();
        void  operator delete[] ( void* data);

    }; // struct AllocateFromAssimpHeap
#endif
} // namespace Intern
} // namespace Assimp

extern "C" {
#endif

#ifdef __cplusplus
static 
const size_t MAXLEN = 1024;
#else
#   define MAXLEN 1024
#endif

// ----------------------------------------------------------------------------------
struct aiPlane
{
#ifdef __cplusplus
    aiPlane () : a(0.f), b(0.f), c(0.f), d(0.f) {}
    aiPlane (ai_real _a, ai_real _b, ai_real _c, ai_real _d)
        : a(_a), b(_b), c(_c), d(_d) {}

    aiPlane (const aiPlane& o) : a(o.a), b(o.b), c(o.c), d(o.d) {}

#endif // !__cplusplus

    ai_real a,b,c,d;
}; // !struct aiPlane

// ----------------------------------------------------------------------------------
struct aiRay
{
#ifdef __cplusplus
    aiRay () {}
    aiRay (const aiVector3D& _pos, const aiVector3D& _dir)
        : pos(_pos), dir(_dir) {}

    aiRay (const aiRay& o) : pos (o.pos), dir (o.dir) {}

#endif // !__cplusplus

    C_STRUCT aiVector3D pos, dir;
}; // !struct aiRay

// ----------------------------------------------------------------------------------
struct aiColor3D
{
#ifdef __cplusplus
    aiColor3D () : r(0.0f), g(0.0f), b(0.0f) {}
    aiColor3D (ai_real _r, ai_real _g, ai_real _b) : r(_r), g(_g), b(_b) {}
    explicit aiColor3D (ai_real _r) : r(_r), g(_r), b(_r) {}
    aiColor3D (const aiColor3D& o) : r(o.r), g(o.g), b(o.b) {}

    // TODO: add epsilon?
    bool operator == (const aiColor3D& other) const
        {return r == other.r && g == other.g && b == other.b;}

    // TODO: add epsilon?
    bool operator != (const aiColor3D& other) const
        {return r != other.r || g != other.g || b != other.b;}

    // TODO: add epsilon?
    bool operator < (const aiColor3D& other) const {
        return r < other.r || ( r == other.r && (g < other.g || (g == other.g && b < other.b ) ) );
    }

    aiColor3D operator+(const aiColor3D& c) const {
        return aiColor3D(r+c.r,g+c.g,b+c.b);
    }

    aiColor3D operator-(const aiColor3D& c) const {
        return aiColor3D(r-c.r,g-c.g,b-c.b);
    }

    aiColor3D operator*(const aiColor3D& c) const {
        return aiColor3D(r*c.r,g*c.g,b*c.b);
    }

    aiColor3D operator*(ai_real f) const {
        return aiColor3D(r*f,g*f,b*f);
    }

    ai_real operator[](unsigned int i) const {
        return *(&r + i);
    }

    ai_real& operator[](unsigned int i) {
        if ( 0 == i ) {
            return r;
        } else if ( 1 == i ) {
            return g;
        } else if ( 2 == i ) {
            return b;
        }
        return r;
    }

    bool IsBlack() const {
        static const ai_real epsilon = ai_real(10e-3);
        return std::fabs( r ) < epsilon && std::fabs( g ) < epsilon && std::fabs( b ) < epsilon;
    }

#endif // !__cplusplus

    ai_real r, g, b;
};  // !struct aiColor3D

// ----------------------------------------------------------------------------------
struct aiString
{
#ifdef __cplusplus

    aiString() :
        length(0)
    {
        data[0] = '\0';

#ifdef ASSIMP_BUILD_DEBUG
        // Debug build: overwrite the string on its full length with ESC (27)
        memset(data+1,27,MAXLEN-1);
#endif
    }

    aiString(const aiString& rOther) :
        length(rOther.length)
    {
        // Crop the string to the maximum length
        length = length>=MAXLEN?MAXLEN-1:length;
        memcpy( data, rOther.data, length);
        data[length] = '\0';
    }

    explicit aiString(const std::string& pString) :
        length(pString.length())
    {
        length = length>=MAXLEN?MAXLEN-1:length;
        memcpy( data, pString.c_str(), length);
        data[length] = '\0';
    }

    void Set( const std::string& pString) {
        if( pString.length() > MAXLEN - 1) {
            return;
        }
        length = pString.length();
        memcpy( data, pString.c_str(), length);
        data[length] = 0;
    }

    void Set( const char* sz) {
        const size_t len = ::strlen(sz);
        if( len > MAXLEN - 1) {
            return;
        }
        length = len;
        memcpy( data, sz, len);
        data[len] = 0;
    }

    aiString& operator = (const char* sz) {
        Set(sz);
        return *this;
    }

    aiString& operator = ( const std::string& pString) {
        Set(pString);
        return *this;
    }

    bool operator==(const aiString& other) const {
        return  (length == other.length && 0 == memcmp(data,other.data,length));
    }

    bool operator!=(const aiString& other) const {
        return  (length != other.length || 0 != memcmp(data,other.data,length));
    }

    void Append (const char* app)   {
        const size_t len = ::strlen(app);
        if (!len) {
            return;
        }
        if (length + len >= MAXLEN) {
            return;
        }

        memcpy(&data[length],app,len+1);
        length += len;
    }

    void Clear ()   {
        length  = 0;
        data[0] = '\0';

#ifdef ASSIMP_BUILD_DEBUG
        // Debug build: overwrite the string on its full length with ESC (27)
        memset(data+1,27,MAXLEN-1);
#endif
    }

    const char* C_Str() const {
        return data;
    }

#endif // !__cplusplus

    size_t length;

    char data[MAXLEN];
} ;  // !struct aiString


// ----------------------------------------------------------------------------------
typedef enum aiReturn
{
    aiReturn_SUCCESS = 0x0,

    aiReturn_FAILURE = -0x1,

    aiReturn_OUTOFMEMORY = -0x3,

    _AI_ENFORCE_ENUM_SIZE = 0x7fffffff

} aiReturn;  // !enum aiReturn

// just for backwards compatibility, don't use these constants anymore
#define AI_SUCCESS     aiReturn_SUCCESS
#define AI_FAILURE     aiReturn_FAILURE
#define AI_OUTOFMEMORY aiReturn_OUTOFMEMORY

// ----------------------------------------------------------------------------------
enum aiOrigin
{
    aiOrigin_SET = 0x0,

    aiOrigin_CUR = 0x1,

    aiOrigin_END = 0x2,

    _AI_ORIGIN_ENFORCE_ENUM_SIZE = 0x7fffffff

}; // !enum aiOrigin

// ----------------------------------------------------------------------------------
enum aiDefaultLogStream
{
    aiDefaultLogStream_FILE = 0x1,

    aiDefaultLogStream_STDOUT = 0x2,

    aiDefaultLogStream_STDERR = 0x4,

    aiDefaultLogStream_DEBUGGER = 0x8,

    _AI_DLS_ENFORCE_ENUM_SIZE = 0x7fffffff
}; // !enum aiDefaultLogStream

// just for backwards compatibility, don't use these constants anymore
#define DLS_FILE     aiDefaultLogStream_FILE
#define DLS_STDOUT   aiDefaultLogStream_STDOUT
#define DLS_STDERR   aiDefaultLogStream_STDERR
#define DLS_DEBUGGER aiDefaultLogStream_DEBUGGER

// ----------------------------------------------------------------------------------
struct aiMemoryInfo
{
#ifdef __cplusplus

    aiMemoryInfo()
        : textures   (0)
        , materials  (0)
        , meshes     (0)
        , nodes      (0)
        , animations (0)
        , cameras    (0)
        , lights     (0)
        , total      (0)
    {}

#endif

    unsigned int textures;

    unsigned int materials;

    unsigned int meshes;

    unsigned int nodes;

    unsigned int animations;

    unsigned int cameras;

    unsigned int lights;

    unsigned int total;
}; // !struct aiMemoryInfo

#ifdef __cplusplus
}
#endif 

// Include implementation files
#include "vector2.inl"
#include "vector3.inl"
#include "color4.inl"
#include "quaternion.inl"
#include "matrix3x3.inl"
#include "matrix4x4.inl"

#endif // AI_TYPES_H_INC