miniassimp

annotate src/ScenePrivate.h @ 0:879c81d94345

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 28 Jan 2019 18:19:26 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2018, assimp team
nuclear@0 6
nuclear@0 7
nuclear@0 8 All rights reserved.
nuclear@0 9
nuclear@0 10 Redistribution and use of this software in source and binary forms,
nuclear@0 11 with or without modification, are permitted provided that the
nuclear@0 12 following conditions are met:
nuclear@0 13
nuclear@0 14 * Redistributions of source code must retain the above
nuclear@0 15 copyright notice, this list of conditions and the
nuclear@0 16 following disclaimer.
nuclear@0 17
nuclear@0 18 * Redistributions in binary form must reproduce the above
nuclear@0 19 copyright notice, this list of conditions and the
nuclear@0 20 following disclaimer in the documentation and/or other
nuclear@0 21 materials provided with the distribution.
nuclear@0 22
nuclear@0 23 * Neither the name of the assimp team, nor the names of its
nuclear@0 24 contributors may be used to endorse or promote products
nuclear@0 25 derived from this software without specific prior
nuclear@0 26 written permission of the assimp team.
nuclear@0 27
nuclear@0 28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 29 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 30 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 31 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 32 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 33 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 34 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 35 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 36 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 37 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 38 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 39
nuclear@0 40 ----------------------------------------------------------------------
nuclear@0 41 */
nuclear@0 42
nuclear@0 43 /** @file Stuff to deal with aiScene::mPrivate
nuclear@0 44 */
nuclear@0 45 #pragma once
nuclear@0 46 #ifndef AI_SCENEPRIVATE_H_INCLUDED
nuclear@0 47 #define AI_SCENEPRIVATE_H_INCLUDED
nuclear@0 48
nuclear@0 49 #include <miniassimp/ai_assert.h>
nuclear@0 50 #include <miniassimp/scene.h>
nuclear@0 51
nuclear@0 52 namespace Assimp {
nuclear@0 53
nuclear@0 54 // Forward declarations
nuclear@0 55 class Importer;
nuclear@0 56
nuclear@0 57 struct ScenePrivateData {
nuclear@0 58 // The struct constructor.
nuclear@0 59 ScenePrivateData() AI_NO_EXCEPT;
nuclear@0 60
nuclear@0 61 // Importer that originally loaded the scene though the C-API
nuclear@0 62 // If set, this object is owned by this private data instance.
nuclear@0 63 Assimp::Importer* mOrigImporter;
nuclear@0 64
nuclear@0 65 // List of post-processing steps already applied to the scene.
nuclear@0 66 unsigned int mPPStepsApplied;
nuclear@0 67
nuclear@0 68 // true if the scene is a copy made with aiCopyScene()
nuclear@0 69 // or the corresponding C++ API. This means that user code
nuclear@0 70 // may have made modifications to it, so mPPStepsApplied
nuclear@0 71 // and mOrigImporter are no longer safe to rely on and only
nuclear@0 72 // serve informative purposes.
nuclear@0 73 bool mIsCopy;
nuclear@0 74 };
nuclear@0 75
nuclear@0 76 inline
nuclear@0 77 ScenePrivateData::ScenePrivateData() AI_NO_EXCEPT
nuclear@0 78 : mOrigImporter( 0 )
nuclear@0 79 , mPPStepsApplied( 0 )
nuclear@0 80 , mIsCopy( false ) {
nuclear@0 81 // empty
nuclear@0 82 }
nuclear@0 83
nuclear@0 84 // Access private data stored in the scene
nuclear@0 85 inline
nuclear@0 86 ScenePrivateData* ScenePriv(aiScene* in) {
nuclear@0 87 ai_assert( 0 != in );
nuclear@0 88 if ( 0 == in ) {
nuclear@0 89 return 0;
nuclear@0 90 }
nuclear@0 91 return static_cast<ScenePrivateData*>(in->mPrivate);
nuclear@0 92 }
nuclear@0 93
nuclear@0 94 inline
nuclear@0 95 const ScenePrivateData* ScenePriv(const aiScene* in) {
nuclear@0 96 ai_assert( 0 != in );
nuclear@0 97 if ( 0 == in ) {
nuclear@0 98 return 0;
nuclear@0 99 }
nuclear@0 100 return static_cast<const ScenePrivateData*>(in->mPrivate);
nuclear@0 101 }
nuclear@0 102
nuclear@0 103 } // Namespace Assimp
nuclear@0 104
nuclear@0 105 #endif // AI_SCENEPRIVATE_H_INCLUDED