Coverage Report

Created: 2025-06-22 07:30

/src/assimp/code/PostProcessing/CalcTangentsProcess.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
43
/** @file Defines a post processing step to calculate tangents and
44
    bi-tangents on all imported meshes.*/
45
#ifndef AI_CALCTANGENTSPROCESS_H_INC
46
#define AI_CALCTANGENTSPROCESS_H_INC
47
48
#include "Common/BaseProcess.h"
49
50
struct aiMesh;
51
52
namespace Assimp
53
{
54
55
// ---------------------------------------------------------------------------
56
/** The CalcTangentsProcess calculates the tangent and bitangent for any vertex
57
 * of all meshes. It is expected to be run before the JoinVerticesProcess runs
58
 * because the joining of vertices also considers tangents and bitangents for
59
 * uniqueness.
60
 */
61
class ASSIMP_API_WINONLY CalcTangentsProcess : public BaseProcess {
62
public:
63
    CalcTangentsProcess();
64
    ~CalcTangentsProcess() override = default;
65
66
    // -------------------------------------------------------------------
67
    /** Returns whether the processing step is present in the given flag.
68
    * @param pFlags The processing flags the importer was called with.
69
    *   A bitwise combination of #aiPostProcessSteps.
70
    * @return true if the process is present in this flag fields,
71
    *   false if not.
72
    */
73
    bool IsActive( unsigned int pFlags) const override;
74
75
    // -------------------------------------------------------------------
76
    /** Called prior to ExecuteOnScene().
77
    * The function is a request to the process to update its configuration
78
    * basing on the Importer's configuration property list.
79
    */
80
    void SetupProperties(const Importer* pImp) override;
81
82
    // setter for configMaxAngle
83
0
    void SetMaxSmoothAngle(float f) {
84
0
        configMaxAngle =f;
85
0
    }
86
87
protected:
88
    // -------------------------------------------------------------------
89
    /** Calculates tangents and bitangents for a specific mesh.
90
    * @param pMesh The mesh to process.
91
    * @param meshIndex Index of the mesh
92
    */
93
    bool ProcessMesh( aiMesh* pMesh, unsigned int meshIndex);
94
95
    // -------------------------------------------------------------------
96
    /** Executes the post processing step on the given imported data.
97
    * @param pScene The imported data to work at.
98
    */
99
    void Execute( aiScene* pScene) override;
100
101
private:
102
    /** Configuration option: maximum smoothing angle, in radians*/
103
    float configMaxAngle;
104
    unsigned int configSourceUV;
105
};
106
107
} // end of namespace Assimp
108
109
#endif // AI_CALCTANGENTSPROCESS_H_INC