Coverage Report

Created: 2025-06-22 07:30

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