vrshoot

annotate libs/assimp/ImproveCacheLocality.h @ 0:b2f14e535253

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2012, assimp team
nuclear@0 6 All rights reserved.
nuclear@0 7
nuclear@0 8 Redistribution and use of this software in source and binary forms,
nuclear@0 9 with or without modification, are permitted provided that the
nuclear@0 10 following conditions are met:
nuclear@0 11
nuclear@0 12 * Redistributions of source code must retain the above
nuclear@0 13 copyright notice, this list of conditions and the
nuclear@0 14 following disclaimer.
nuclear@0 15
nuclear@0 16 * Redistributions in binary form must reproduce the above
nuclear@0 17 copyright notice, this list of conditions and the
nuclear@0 18 following disclaimer in the documentation and/or other
nuclear@0 19 materials provided with the distribution.
nuclear@0 20
nuclear@0 21 * Neither the name of the assimp team, nor the names of its
nuclear@0 22 contributors may be used to endorse or promote products
nuclear@0 23 derived from this software without specific prior
nuclear@0 24 written permission of the assimp team.
nuclear@0 25
nuclear@0 26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 37
nuclear@0 38 ----------------------------------------------------------------------
nuclear@0 39 */
nuclear@0 40
nuclear@0 41 /** @file Defines a post processing step to reorder faces for
nuclear@0 42 better cache locality*/
nuclear@0 43 #ifndef AI_IMPROVECACHELOCALITY_H_INC
nuclear@0 44 #define AI_IMPROVECACHELOCALITY_H_INC
nuclear@0 45
nuclear@0 46 #include "BaseProcess.h"
nuclear@0 47 #include "assimp/types.h"
nuclear@0 48
nuclear@0 49 struct aiMesh;
nuclear@0 50
nuclear@0 51 namespace Assimp
nuclear@0 52 {
nuclear@0 53
nuclear@0 54 // ---------------------------------------------------------------------------
nuclear@0 55 /** The ImproveCacheLocalityProcess reorders all faces for improved vertex
nuclear@0 56 * cache locality. It tries to arrange all faces to fans and to render
nuclear@0 57 * faces which share vertices directly one after the other.
nuclear@0 58 *
nuclear@0 59 * @note This step expects triagulated input data.
nuclear@0 60 */
nuclear@0 61 class ImproveCacheLocalityProcess : public BaseProcess
nuclear@0 62 {
nuclear@0 63 public:
nuclear@0 64
nuclear@0 65 ImproveCacheLocalityProcess();
nuclear@0 66 ~ImproveCacheLocalityProcess();
nuclear@0 67
nuclear@0 68 public:
nuclear@0 69
nuclear@0 70 // -------------------------------------------------------------------
nuclear@0 71 // Check whether the pp step is active
nuclear@0 72 bool IsActive( unsigned int pFlags) const;
nuclear@0 73
nuclear@0 74 // -------------------------------------------------------------------
nuclear@0 75 // Executes the pp step on a given scene
nuclear@0 76 void Execute( aiScene* pScene);
nuclear@0 77
nuclear@0 78 // -------------------------------------------------------------------
nuclear@0 79 // Configures the pp step
nuclear@0 80 void SetupProperties(const Importer* pImp);
nuclear@0 81
nuclear@0 82 protected:
nuclear@0 83 // -------------------------------------------------------------------
nuclear@0 84 /** Executes the postprocessing step on the given mesh
nuclear@0 85 * @param pMesh The mesh to process.
nuclear@0 86 * @param meshNum Index of the mesh to process
nuclear@0 87 */
nuclear@0 88 float ProcessMesh( aiMesh* pMesh, unsigned int meshNum);
nuclear@0 89
nuclear@0 90 private:
nuclear@0 91 //! Configuration parameter: specifies the size of the cache to
nuclear@0 92 //! optimize the vertex data for.
nuclear@0 93 unsigned int configCacheDepth;
nuclear@0 94 };
nuclear@0 95
nuclear@0 96 } // end of namespace Assimp
nuclear@0 97
nuclear@0 98 #endif // AI_IMPROVECACHELOCALITY_H_INC