Coverage Report

Created: 2024-08-02 07:04

/src/assimp/code/PostProcessing/TriangulateProcess.h
Line
Count
Source
1
/*
2
Open Asset Import Library (assimp)
3
----------------------------------------------------------------------
4
5
Copyright (c) 2006-2024, 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 Defines a post processing step to triangulate all faces
44
          with more than three vertices.
45
 */
46
#ifndef AI_TRIANGULATEPROCESS_H_INC
47
#define AI_TRIANGULATEPROCESS_H_INC
48
49
#include "Common/BaseProcess.h"
50
51
struct aiMesh;
52
53
class TriangulateProcessTest;
54
55
namespace Assimp {
56
57
// ---------------------------------------------------------------------------
58
/** The TriangulateProcess splits up all faces with more than three indices
59
 * into triangles. You usually want this to happen because the graphics cards
60
 * need their data as triangles.
61
 */
62
class ASSIMP_API TriangulateProcess : public BaseProcess {
63
public:
64
    // -------------------------------------------------------------------
65
    /// The default class constructor / destructor.
66
33
    TriangulateProcess() = default;
67
    ~TriangulateProcess() override = default;
68
69
    // -------------------------------------------------------------------
70
    /** Returns whether the processing step is present in the given flag field.
71
     * @param pFlags The processing flags the importer was called with. A bitwise
72
     *   combination of #aiPostProcessSteps.
73
     * @return true if the process is present in this flag fields, false if not.
74
    */
75
    bool IsActive( unsigned int pFlags) const override;
76
77
    // -------------------------------------------------------------------
78
    /** Executes the post processing step on the given imported data.
79
    * At the moment a process is not supposed to fail.
80
    * @param pScene The imported data to work at.
81
    */
82
    void Execute( aiScene* pScene) override;
83
84
    // -------------------------------------------------------------------
85
    /** Triangulates the given mesh.
86
     * @param pMesh The mesh to triangulate.
87
     */
88
    bool TriangulateMesh( aiMesh* pMesh);
89
};
90
91
} // end of namespace Assimp
92
93
#endif // AI_TRIANGULATEPROCESS_H_INC