1/*
2Open Asset Import Library (assimp)
3----------------------------------------------------------------------
4
5Copyright (c) 2006-2017, assimp team
6
7All rights reserved.
8
9Redistribution and use of this software in source and binary forms,
10with or without modification, are permitted provided that the
11following 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
27THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37OF 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 "BaseProcess.h"
48#include <assimp/mesh.h>
49#include <assimp/material.h>
50#include <assimp/types.h>
51
52class ComputeUVMappingTest;
53
54namespace Assimp {
55
56// ---------------------------------------------------------------------------
57/** ComputeUVMappingProcess - converts special mappings, such as spherical,
58 * cylindrical or boxed to proper UV coordinates for rendering.
59*/
60class ComputeUVMappingProcess : public BaseProcess
61{
62public:
63 ComputeUVMappingProcess();
64 ~ComputeUVMappingProcess();
65
66public:
67
68 // -------------------------------------------------------------------
69 /** Returns whether the processing step is present in the given flag field.
70 * @param pFlags The processing flags the importer was called with. A bitwise
71 * combination of #aiPostProcessSteps.
72 * @return true if the process is present in this flag fields, false if not.
73 */
74 bool IsActive( unsigned int pFlags) const;
75
76 // -------------------------------------------------------------------
77 /** Executes the post processing step on the given imported data.
78 * At the moment a process is not supposed to fail.
79 * @param pScene The imported data to work at.
80 */
81 void Execute( aiScene* pScene);
82
83protected:
84
85 // -------------------------------------------------------------------
86 /** Computes spherical UV coordinates for a mesh
87 *
88 * @param mesh Mesh to be processed
89 * @param axis Main axis
90 * @param out Receives output UV coordinates
91 */
92 void ComputeSphereMapping(aiMesh* mesh,const aiVector3D& axis,
93 aiVector3D* out);
94
95 // -------------------------------------------------------------------
96 /** Computes cylindrical UV coordinates for a mesh
97 *
98 * @param mesh Mesh to be processed
99 * @param axis Main axis
100 * @param out Receives output UV coordinates
101 */
102 void ComputeCylinderMapping(aiMesh* mesh,const aiVector3D& axis,
103 aiVector3D* out);
104
105 // -------------------------------------------------------------------
106 /** Computes planar UV coordinates for a mesh
107 *
108 * @param mesh Mesh to be processed
109 * @param axis Main axis
110 * @param out Receives output UV coordinates
111 */
112 void ComputePlaneMapping(aiMesh* mesh,const aiVector3D& axis,
113 aiVector3D* out);
114
115 // -------------------------------------------------------------------
116 /** Computes cubic UV coordinates for a mesh
117 *
118 * @param mesh Mesh to be processed
119 * @param out Receives output UV coordinates
120 */
121 void ComputeBoxMapping(aiMesh* mesh, aiVector3D* out);
122
123private:
124
125 // temporary structure to describe a mapping
126 struct MappingInfo
127 {
128 explicit MappingInfo(aiTextureMapping _type)
129 : type (_type)
130 , axis (0.f,1.f,0.f)
131 , uv (0u)
132 {}
133
134 aiTextureMapping type;
135 aiVector3D axis;
136 unsigned int uv;
137
138 bool operator== (const MappingInfo& other)
139 {
140 return type == other.type && axis == other.axis;
141 }
142 };
143};
144
145} // end of namespace Assimp
146
147#endif // AI_COMPUTEUVMAPPING_H_INC
148