scene.h

Go to the documentation of this file.

/*
---------------------------------------------------------------------------
Open Asset Import Library (assimp)
---------------------------------------------------------------------------
 
Copyright (c) 2006-2020, 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_SCENE_H_INC
#define AI_SCENE_H_INC
 
#ifdef __GNUC__
#   pragma GCC system_header
#endif
 
#include <assimp/types.h>
#include <assimp/texture.h>
#include <assimp/mesh.h>
#include <assimp/light.h>
#include <assimp/camera.h>
#include <assimp/material.h>
#include <assimp/anim.h>
#include <assimp/metadata.h>
 
#ifdef __cplusplus
#  include <cstdlib>
extern "C" {
#endif
 
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wattributes"
#endif
 
// -------------------------------------------------------------------------------
// -------------------------------------------------------------------------------
struct ASSIMP_API aiNode
{
    C_STRUCT aiString mName;
 
    C_STRUCT aiMatrix4x4 mTransformation;
 
    C_STRUCT aiNode* mParent;
 
    unsigned int mNumChildren;
 
    C_STRUCT aiNode** mChildren;
 
    unsigned int mNumMeshes;
 
    unsigned int* mMeshes;
 
    C_STRUCT aiMetadata* mMetaData;
 
#ifdef __cplusplus
 
    aiNode();
 
    explicit aiNode(const std::string& name);
 
    ~aiNode();
 
    inline 
    const aiNode* FindNode(const aiString& name) const {
        return FindNode(name.data);
    }
 
    inline 
    aiNode* FindNode(const aiString& name) {
        return FindNode(name.data);
    }
 
    const aiNode* FindNode(const char* name) const;
 
    aiNode* FindNode(const char* name);
 
    void addChildren(unsigned int numChildren, aiNode **children);
#endif // __cplusplus
};
 
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
 
// -------------------------------------------------------------------------------
#define AI_SCENE_FLAGS_INCOMPLETE   0x1
 
#define AI_SCENE_FLAGS_VALIDATED    0x2
 
#define AI_SCENE_FLAGS_VALIDATION_WARNING   0x4
 
#define AI_SCENE_FLAGS_NON_VERBOSE_FORMAT   0x8
 
#define AI_SCENE_FLAGS_TERRAIN 0x10
 
#define AI_SCENE_FLAGS_ALLOW_SHARED         0x20
 
// -------------------------------------------------------------------------------
// -------------------------------------------------------------------------------
struct aiScene
{
    unsigned int mFlags;
 
    C_STRUCT aiNode* mRootNode;
 
    unsigned int mNumMeshes;
 
    C_STRUCT aiMesh** mMeshes;
 
    unsigned int mNumMaterials;
 
    C_STRUCT aiMaterial** mMaterials;
 
    unsigned int mNumAnimations;
 
    C_STRUCT aiAnimation** mAnimations;
 
    unsigned int mNumTextures;
 
    C_STRUCT aiTexture** mTextures;
 
    unsigned int mNumLights;
 
    C_STRUCT aiLight** mLights;
 
    unsigned int mNumCameras;
 
    C_STRUCT aiCamera** mCameras;
 
    C_STRUCT aiMetadata* mMetaData;
 
 
#ifdef __cplusplus
 
    ASSIMP_API aiScene();
 
    ASSIMP_API ~aiScene();
 
    inline bool HasMeshes() const { 
        return mMeshes != nullptr && mNumMeshes > 0; 
    }
 
    inline bool HasMaterials() const { 
        return mMaterials != nullptr && mNumMaterials > 0; 
    }
 
    inline bool HasLights() const { 
        return mLights != nullptr && mNumLights > 0; 
    }
 
    inline bool HasTextures() const {
        return mTextures != nullptr && mNumTextures > 0; 
    }
 
    inline bool HasCameras() const {
        return mCameras != nullptr && mNumCameras > 0; 
    }
 
    inline bool HasAnimations() const { 
        return mAnimations != nullptr && mNumAnimations > 0; 
    }
 
    static const char* GetShortFilename(const char* filename) {
        const char* lastSlash = strrchr(filename, '/');
        if (lastSlash == nullptr) {
            lastSlash = strrchr(filename, '\\');
        }
        const char* shortFilename = lastSlash != nullptr ? lastSlash + 1 : filename;
        return shortFilename;
    }
 
    const aiTexture* GetEmbeddedTexture(const char* filename) const {
        // lookup using texture ID (if referenced like: "*1", "*2", etc.)
        if ('*' == *filename) {
            int index = std::atoi(filename + 1);
            if (0 > index || mNumTextures <= static_cast<unsigned>(index))
                return nullptr;
            return mTextures[index];
        }
        // lookup using filename
        const char* shortFilename = GetShortFilename(filename);
        for (unsigned int i = 0; i < mNumTextures; i++) {
            const char* shortTextureFilename = GetShortFilename(mTextures[i]->mFilename.C_Str());
            if (strcmp(shortTextureFilename, shortFilename) == 0) {
                return mTextures[i];
            }
        }
        return nullptr;
    }
#endif // __cplusplus
 
#ifdef __cplusplus
    void* mPrivate;
#else
    char* mPrivate;
#endif
 
};
 
#ifdef __cplusplus
} 
#endif
 
#endif // AI_SCENE_H_INC