Coverage Report

Created: 2025-08-28 06:38

/src/assimp/code/Common/ScenePreprocessor.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 Defines a post processing step to search all meshes for
43
  degenerated faces */
44
#ifndef AI_SCENE_PREPROCESSOR_H_INC
45
#define AI_SCENE_PREPROCESSOR_H_INC
46
47
#include <assimp/defs.h>
48
#include <stddef.h>
49
50
struct aiScene;
51
struct aiAnimation;
52
struct aiMesh;
53
54
class ScenePreprocessorTest;
55
namespace Assimp {
56
57
// ----------------------------------------------------------------------------------
58
/** ScenePreprocessor: Pre-process a scene before any post-processing
59
 *  steps are executed.
60
 *
61
 *  The step computes data that needn't necessarily be provided by the
62
 *  importer, such as aiMesh::mPrimitiveTypes.
63
*/
64
// ----------------------------------------------------------------------------------
65
class ASSIMP_API ScenePreprocessor {
66
    // Make ourselves a friend of the corresponding test unit.
67
    friend class ::ScenePreprocessorTest;
68
69
public:
70
    // ----------------------------------------------------------------
71
    /** Default c'tpr. Use SetScene() to assign a scene to the object.
72
     */
73
    ScenePreprocessor() :
74
0
            scene(nullptr) {}
75
76
    /** Constructs the object and assigns a specific scene to it
77
     */
78
    ScenePreprocessor(aiScene *_scene) :
79
113
            scene(_scene) {}
80
81
    /// @brief The class destructor.
82
    ~ScenePreprocessor() = default;
83
84
    // ----------------------------------------------------------------
85
    /** Assign a (new) scene to the object.
86
     *
87
     *  One 'SceneProcessor' can be used for multiple scenes.
88
     *  Call ProcessScene to have the scene preprocessed.
89
     *  @param sc Scene to be processed.
90
     */
91
0
    void SetScene(aiScene *sc) {
92
0
        scene = sc;
93
0
    }
94
95
    // ----------------------------------------------------------------
96
    /** Preprocess the current scene
97
     */
98
    void ProcessScene();
99
100
protected:
101
    // ----------------------------------------------------------------
102
    /** Preprocess an animation in the scene
103
     *  @param anim Anim to be preprocessed.
104
     */
105
    void ProcessAnimation(aiAnimation *anim);
106
107
    // ----------------------------------------------------------------
108
    /** Preprocess a mesh in the scene
109
     *  @param mesh Mesh to be preprocessed.
110
     */
111
    void ProcessMesh(aiMesh *mesh);
112
113
protected:
114
    //! Scene we're currently working on
115
    aiScene *scene;
116
};
117
118
} // namespace Assimp
119
120
#endif // include guard