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 reorder faces for
43 better cache locality*/
44#ifndef AI_IMPROVECACHELOCALITY_H_INC
45#define AI_IMPROVECACHELOCALITY_H_INC
46
47#include "BaseProcess.h"
48#include <assimp/types.h>
49
50struct aiMesh;
51
52namespace Assimp
53{
54
55// ---------------------------------------------------------------------------
56/** The ImproveCacheLocalityProcess reorders all faces for improved vertex
57 * cache locality. It tries to arrange all faces to fans and to render
58 * faces which share vertices directly one after the other.
59 *
60 * @note This step expects triagulated input data.
61 */
62class ImproveCacheLocalityProcess : public BaseProcess
63{
64public:
65
66 ImproveCacheLocalityProcess();
67 ~ImproveCacheLocalityProcess();
68
69public:
70
71 // -------------------------------------------------------------------
72 // Check whether the pp step is active
73 bool IsActive( unsigned int pFlags) const;
74
75 // -------------------------------------------------------------------
76 // Executes the pp step on a given scene
77 void Execute( aiScene* pScene);
78
79 // -------------------------------------------------------------------
80 // Configures the pp step
81 void SetupProperties(const Importer* pImp);
82
83protected:
84 // -------------------------------------------------------------------
85 /** Executes the postprocessing step on the given mesh
86 * @param pMesh The mesh to process.
87 * @param meshNum Index of the mesh to process
88 */
89 float ProcessMesh( aiMesh* pMesh, unsigned int meshNum);
90
91private:
92 //! Configuration parameter: specifies the size of the cache to
93 //! optimize the vertex data for.
94 unsigned int configCacheDepth;
95};
96
97} // end of namespace Assimp
98
99#endif // AI_IMPROVECACHELOCALITY_H_INC
100