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