/src/assimp/code/PostProcessing/ComputeUVMappingProcess.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 compute UV coordinates |
43 | | from abstract mappings, such as box or spherical*/ |
44 | | #ifndef AI_COMPUTEUVMAPPING_H_INC |
45 | | #define AI_COMPUTEUVMAPPING_H_INC |
46 | | |
47 | | #include "Common/BaseProcess.h" |
48 | | |
49 | | #include <assimp/mesh.h> |
50 | | #include <assimp/material.h> |
51 | | #include <assimp/types.h> |
52 | | |
53 | | class ComputeUVMappingTest; |
54 | | |
55 | | namespace Assimp { |
56 | | |
57 | | // --------------------------------------------------------------------------- |
58 | | /** ComputeUVMappingProcess - converts special mappings, such as spherical, |
59 | | * cylindrical or boxed to proper UV coordinates for rendering. |
60 | | */ |
61 | | class ComputeUVMappingProcess : public BaseProcess { |
62 | | public: |
63 | 1.77k | ComputeUVMappingProcess() = default; |
64 | | ~ComputeUVMappingProcess() override = default; |
65 | | |
66 | | // ------------------------------------------------------------------- |
67 | | /** Returns whether the processing step is present in the given flag field. |
68 | | * @param pFlags The processing flags the importer was called with. A bitwise |
69 | | * combination of #aiPostProcessSteps. |
70 | | * @return true if the process is present in this flag fields, false if not. |
71 | | */ |
72 | | bool IsActive( unsigned int pFlags) const override; |
73 | | |
74 | | // ------------------------------------------------------------------- |
75 | | /** Executes the post processing step on the given imported data. |
76 | | * At the moment a process is not supposed to fail. |
77 | | * @param pScene The imported data to work at. |
78 | | */ |
79 | | void Execute( aiScene* pScene) override; |
80 | | |
81 | | protected: |
82 | | |
83 | | // ------------------------------------------------------------------- |
84 | | /** Computes spherical UV coordinates for a mesh |
85 | | * |
86 | | * @param mesh Mesh to be processed |
87 | | * @param axis Main axis |
88 | | * @param out Receives output UV coordinates |
89 | | */ |
90 | | void ComputeSphereMapping(aiMesh* mesh,const aiVector3D& axis, |
91 | | aiVector3D* out); |
92 | | |
93 | | // ------------------------------------------------------------------- |
94 | | /** Computes cylindrical UV coordinates for a mesh |
95 | | * |
96 | | * @param mesh Mesh to be processed |
97 | | * @param axis Main axis |
98 | | * @param out Receives output UV coordinates |
99 | | */ |
100 | | void ComputeCylinderMapping(aiMesh* mesh,const aiVector3D& axis, |
101 | | aiVector3D* out); |
102 | | |
103 | | // ------------------------------------------------------------------- |
104 | | /** Computes planar UV coordinates for a mesh |
105 | | * |
106 | | * @param mesh Mesh to be processed |
107 | | * @param axis Main axis |
108 | | * @param out Receives output UV coordinates |
109 | | */ |
110 | | void ComputePlaneMapping(aiMesh* mesh,const aiVector3D& axis, |
111 | | aiVector3D* out); |
112 | | |
113 | | // ------------------------------------------------------------------- |
114 | | /** Computes cubic UV coordinates for a mesh |
115 | | * |
116 | | * @param mesh Mesh to be processed |
117 | | * @param out Receives output UV coordinates |
118 | | */ |
119 | | void ComputeBoxMapping(aiMesh* mesh, aiVector3D* out); |
120 | | |
121 | | private: |
122 | | |
123 | | // temporary structure to describe a mapping |
124 | | struct MappingInfo { |
125 | | explicit MappingInfo(aiTextureMapping _type) |
126 | 0 | : type (_type) |
127 | 0 | , axis (0.f,1.f,0.f) |
128 | 0 | , uv (0u) |
129 | 0 | {} |
130 | | |
131 | | aiTextureMapping type; |
132 | | aiVector3D axis; |
133 | | unsigned int uv; |
134 | | |
135 | 0 | bool operator== (const MappingInfo& other) { |
136 | 0 | return type == other.type && axis == other.axis; |
137 | 0 | } |
138 | | }; |
139 | | }; |
140 | | |
141 | | } // end of namespace Assimp |
142 | | |
143 | | #endif // AI_COMPUTEUVMAPPING_H_INC |