scene.h

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

Copyright (c) 2006-2012, 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.
---------------------------------------------------------------------------
*/

#ifndef __AI_SCENE_H_INC__
#define __AI_SCENE_H_INC__

#include "types.h"
#include "texture.h"
#include "mesh.h"
#include "light.h"
#include "camera.h"
#include "material.h"
#include "anim.h"
#include "metadata.h"

#ifdef __cplusplus
extern "C" {
#endif


// -------------------------------------------------------------------------------
// -------------------------------------------------------------------------------
struct 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() 
        // set all members to zero by default
        : mName("")
        , mParent(NULL)
        , mNumChildren(0)
        , mChildren(NULL)
        , mNumMeshes(0)
        , mMeshes(NULL)
        , mMetaData(NULL)
    {
    }
    

    aiNode(const std::string& name) 
        // set all members to zero by default
        : mName(name)
        , mParent(NULL)
        , mNumChildren(0)
        , mChildren(NULL)
        , mNumMeshes(0)
        , mMeshes(NULL)
        , mMetaData(NULL)
    {
    }

    ~aiNode()
    {
        // delete all children recursively
        // to make sure we won't crash if the data is invalid ...
        if (mChildren && mNumChildren)  
        {
            for( unsigned int a = 0; a < mNumChildren; a++)
                delete mChildren[a];
        }
        delete [] mChildren;
        delete [] mMeshes;
        delete mMetaData;
    }


    inline const aiNode* FindNode(const aiString& name) const
    {
        return FindNode(name.data);
    }


    inline aiNode* FindNode(const aiString& name)
    {
        return FindNode(name.data);
    }


    inline const aiNode* FindNode(const char* name) const
    {
        if (!::strcmp( mName.data,name))return this;
        for (unsigned int i = 0; i < mNumChildren;++i)
        {
            const aiNode* const p = mChildren[i]->FindNode(name);
            if (p) {
                return p;
            }
        }
        // there is definitely no sub-node with this name
        return NULL;
    }

    inline aiNode* FindNode(const char* name) 
    {
        if (!::strcmp( mName.data,name))return this;
        for (unsigned int i = 0; i < mNumChildren;++i)
        {
            aiNode* const p = mChildren[i]->FindNode(name);
            if (p) {
                return p;
            }
        }
        // there is definitely no sub-node with this name
        return NULL;
    }

#endif // __cplusplus
};


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


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

#ifdef __cplusplus

    ASSIMP_API aiScene();

    ASSIMP_API ~aiScene();

    inline bool HasMeshes() const 
        { return mMeshes != NULL && mNumMeshes > 0; }

    inline bool HasMaterials() const 
        { return mMaterials != NULL && mNumMaterials > 0; }

    inline bool HasLights() const 
        { return mLights != NULL && mNumLights > 0; }

    inline bool HasTextures() const 
        { return mTextures != NULL && mNumTextures > 0; }

    inline bool HasCameras() const 
        { return mCameras != NULL && mNumCameras > 0; }

    inline bool HasAnimations() const 
        { return mAnimations != NULL && mNumAnimations > 0; }

#endif // __cplusplus


#ifdef __cplusplus
    void* mPrivate;
#else
    char* mPrivate;
#endif

};

#ifdef __cplusplus
} 
#endif

#endif // __AI_SCENE_H_INC__