/src/assimp/code/PostProcessing/GenVertexNormalsProcess.h
Line | Count | Source |
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 compute vertex normals |
43 | | for all loaded vertizes */ |
44 | | #ifndef AI_GENVERTEXNORMALPROCESS_H_INC |
45 | | #define AI_GENVERTEXNORMALPROCESS_H_INC |
46 | | |
47 | | #include "Common/assbin_chunks.h" |
48 | | #include "Common/BaseProcess.h" |
49 | | |
50 | | #include <assimp/mesh.h> |
51 | | |
52 | | // Forward declarations |
53 | | class GenNormalsTest; |
54 | | |
55 | | namespace Assimp { |
56 | | |
57 | | // --------------------------------------------------------------------------- |
58 | | /** The GenFaceNormalsProcess computes vertex normals for all vertices |
59 | | */ |
60 | | class ASSIMP_API GenVertexNormalsProcess : public BaseProcess { |
61 | | public: |
62 | | // ------------------------------------------------------------------- |
63 | | /// The default class constructor / destructor. |
64 | | GenVertexNormalsProcess(); |
65 | | ~GenVertexNormalsProcess() override = default; |
66 | | |
67 | | // ------------------------------------------------------------------- |
68 | | /** Returns whether the processing step is present in the given flag. |
69 | | * @param pFlags The processing flags the importer was called with. |
70 | | * A bitwise combination of #aiPostProcessSteps. |
71 | | * @return true if the process is present in this flag fields, |
72 | | * false if not. |
73 | | */ |
74 | | bool IsActive( unsigned int pFlags) const override; |
75 | | |
76 | | // ------------------------------------------------------------------- |
77 | | /** Called prior to ExecuteOnScene(). |
78 | | * The function is a request to the process to update its configuration |
79 | | * basing on the Importer's configuration property list. |
80 | | */ |
81 | | void SetupProperties(const Importer* pImp) override; |
82 | | |
83 | | // ------------------------------------------------------------------- |
84 | | /** Executes the post processing step on the given imported data. |
85 | | * At the moment a process is not supposed to fail. |
86 | | * @param pScene The imported data to work at. |
87 | | */ |
88 | | void Execute( aiScene* pScene) override; |
89 | | |
90 | | // setter for configMaxAngle |
91 | 0 | inline void SetMaxSmoothAngle(ai_real f) { |
92 | 0 | configMaxAngle =f; |
93 | 0 | } |
94 | | |
95 | | // ------------------------------------------------------------------- |
96 | | /** Computes normals for a specific mesh |
97 | | * @param pcMesh Mesh |
98 | | * @param meshIndex Index of the mesh |
99 | | * @return true if vertex normals have been computed |
100 | | */ |
101 | | bool GenMeshVertexNormals (aiMesh* pcMesh, unsigned int meshIndex); |
102 | | |
103 | | private: |
104 | | /** Configuration option: maximum smoothing angle, in radians*/ |
105 | | ai_real configMaxAngle; |
106 | | mutable bool force_ = false; |
107 | | mutable bool flippedWindingOrder_ = false; |
108 | | mutable bool leftHanded_ = false; |
109 | | }; |
110 | | |
111 | | } // end of namespace Assimp |
112 | | |
113 | | #endif // !!AI_GENVERTEXNORMALPROCESS_H_INC |