vrshoot

annotate libs/assimp/SplitLargeMeshes.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 split large meshes into submeshes
nuclear@0 42 */
nuclear@0 43 #ifndef AI_SPLITLARGEMESHES_H_INC
nuclear@0 44 #define AI_SPLITLARGEMESHES_H_INC
nuclear@0 45
nuclear@0 46 #include <vector>
nuclear@0 47 #include "BaseProcess.h"
nuclear@0 48
nuclear@0 49 #include "assimp/mesh.h"
nuclear@0 50 #include "assimp/scene.h"
nuclear@0 51
nuclear@0 52 class SplitLargeMeshesTest;
nuclear@0 53 namespace Assimp
nuclear@0 54 {
nuclear@0 55
nuclear@0 56 class SplitLargeMeshesProcess_Triangle;
nuclear@0 57 class SplitLargeMeshesProcess_Vertex;
nuclear@0 58
nuclear@0 59 // NOTE: If you change these limits, don't forget to change the
nuclear@0 60 // corresponding values in all Assimp ports
nuclear@0 61
nuclear@0 62 // **********************************************************
nuclear@0 63 // Java: ConfigProperty.java,
nuclear@0 64 // ConfigProperty.DEFAULT_VERTEX_SPLIT_LIMIT
nuclear@0 65 // ConfigProperty.DEFAULT_TRIANGLE_SPLIT_LIMIT
nuclear@0 66 // **********************************************************
nuclear@0 67
nuclear@0 68 // default limit for vertices
nuclear@0 69 #if (!defined AI_SLM_DEFAULT_MAX_VERTICES)
nuclear@0 70 # define AI_SLM_DEFAULT_MAX_VERTICES 1000000
nuclear@0 71 #endif
nuclear@0 72
nuclear@0 73 // default limit for triangles
nuclear@0 74 #if (!defined AI_SLM_DEFAULT_MAX_TRIANGLES)
nuclear@0 75 # define AI_SLM_DEFAULT_MAX_TRIANGLES 1000000
nuclear@0 76 #endif
nuclear@0 77
nuclear@0 78 // ---------------------------------------------------------------------------
nuclear@0 79 /** Postprocessing filter to split large meshes into submeshes
nuclear@0 80 *
nuclear@0 81 * Applied BEFORE the JoinVertices-Step occurs.
nuclear@0 82 * Returns NON-UNIQUE vertices, splits by triangle number.
nuclear@0 83 */
nuclear@0 84 class SplitLargeMeshesProcess_Triangle : public BaseProcess
nuclear@0 85 {
nuclear@0 86 friend class SplitLargeMeshesProcess_Vertex;
nuclear@0 87
nuclear@0 88 public:
nuclear@0 89
nuclear@0 90 SplitLargeMeshesProcess_Triangle();
nuclear@0 91 ~SplitLargeMeshesProcess_Triangle();
nuclear@0 92
nuclear@0 93 public:
nuclear@0 94 // -------------------------------------------------------------------
nuclear@0 95 /** Returns whether the processing step is present in the given flag.
nuclear@0 96 * @param pFlags The processing flags the importer was called with. A
nuclear@0 97 * bitwise combination of #aiPostProcessSteps.
nuclear@0 98 * @return true if the process is present in this flag fields,
nuclear@0 99 * false if not.
nuclear@0 100 */
nuclear@0 101 bool IsActive( unsigned int pFlags) const;
nuclear@0 102
nuclear@0 103
nuclear@0 104 // -------------------------------------------------------------------
nuclear@0 105 /** Called prior to ExecuteOnScene().
nuclear@0 106 * The function is a request to the process to update its configuration
nuclear@0 107 * basing on the Importer's configuration property list.
nuclear@0 108 */
nuclear@0 109 virtual void SetupProperties(const Importer* pImp);
nuclear@0 110
nuclear@0 111
nuclear@0 112 //! Set the split limit - needed for unit testing
nuclear@0 113 inline void SetLimit(unsigned int l)
nuclear@0 114 {LIMIT = l;}
nuclear@0 115
nuclear@0 116 //! Get the split limit
nuclear@0 117 inline unsigned int GetLimit() const
nuclear@0 118 {return LIMIT;}
nuclear@0 119
nuclear@0 120 public:
nuclear@0 121
nuclear@0 122 // -------------------------------------------------------------------
nuclear@0 123 /** Executes the post processing step on the given imported data.
nuclear@0 124 * At the moment a process is not supposed to fail.
nuclear@0 125 * @param pScene The imported data to work at.
nuclear@0 126 */
nuclear@0 127 void Execute( aiScene* pScene);
nuclear@0 128
nuclear@0 129 // -------------------------------------------------------------------
nuclear@0 130 //! Apply the algorithm to a given mesh
nuclear@0 131 void SplitMesh (unsigned int a, aiMesh* pcMesh,
nuclear@0 132 std::vector<std::pair<aiMesh*, unsigned int> >& avList);
nuclear@0 133
nuclear@0 134 // -------------------------------------------------------------------
nuclear@0 135 //! Update a node in the asset after a few of its meshes
nuclear@0 136 //! have been split
nuclear@0 137 static void UpdateNode(aiNode* pcNode,
nuclear@0 138 const std::vector<std::pair<aiMesh*, unsigned int> >& avList);
nuclear@0 139
nuclear@0 140 public:
nuclear@0 141 //! Triangle limit
nuclear@0 142 unsigned int LIMIT;
nuclear@0 143 };
nuclear@0 144
nuclear@0 145
nuclear@0 146 // ---------------------------------------------------------------------------
nuclear@0 147 /** Postprocessing filter to split large meshes into submeshes
nuclear@0 148 *
nuclear@0 149 * Applied AFTER the JoinVertices-Step occurs.
nuclear@0 150 * Returns UNIQUE vertices, splits by vertex number.
nuclear@0 151 */
nuclear@0 152 class SplitLargeMeshesProcess_Vertex : public BaseProcess
nuclear@0 153 {
nuclear@0 154 public:
nuclear@0 155
nuclear@0 156 SplitLargeMeshesProcess_Vertex();
nuclear@0 157 ~SplitLargeMeshesProcess_Vertex();
nuclear@0 158
nuclear@0 159 public:
nuclear@0 160 // -------------------------------------------------------------------
nuclear@0 161 /** Returns whether the processing step is present in the given flag field.
nuclear@0 162 * @param pFlags The processing flags the importer was called with. A bitwise
nuclear@0 163 * combination of #aiPostProcessSteps.
nuclear@0 164 * @return true if the process is present in this flag fields, false if not.
nuclear@0 165 */
nuclear@0 166 bool IsActive( unsigned int pFlags) const;
nuclear@0 167
nuclear@0 168 // -------------------------------------------------------------------
nuclear@0 169 /** Called prior to ExecuteOnScene().
nuclear@0 170 * The function is a request to the process to update its configuration
nuclear@0 171 * basing on the Importer's configuration property list.
nuclear@0 172 */
nuclear@0 173 virtual void SetupProperties(const Importer* pImp);
nuclear@0 174
nuclear@0 175
nuclear@0 176 //! Set the split limit - needed for unit testing
nuclear@0 177 inline void SetLimit(unsigned int l)
nuclear@0 178 {LIMIT = l;}
nuclear@0 179
nuclear@0 180 //! Get the split limit
nuclear@0 181 inline unsigned int GetLimit() const
nuclear@0 182 {return LIMIT;}
nuclear@0 183
nuclear@0 184 public:
nuclear@0 185
nuclear@0 186 // -------------------------------------------------------------------
nuclear@0 187 /** Executes the post processing step on the given imported data.
nuclear@0 188 * At the moment a process is not supposed to fail.
nuclear@0 189 * @param pScene The imported data to work at.
nuclear@0 190 */
nuclear@0 191 void Execute( aiScene* pScene);
nuclear@0 192
nuclear@0 193 // -------------------------------------------------------------------
nuclear@0 194 //! Apply the algorithm to a given mesh
nuclear@0 195 void SplitMesh (unsigned int a, aiMesh* pcMesh,
nuclear@0 196 std::vector<std::pair<aiMesh*, unsigned int> >& avList);
nuclear@0 197
nuclear@0 198 // NOTE: Reuse SplitLargeMeshesProcess_Triangle::UpdateNode()
nuclear@0 199
nuclear@0 200 public:
nuclear@0 201 //! Triangle limit
nuclear@0 202 unsigned int LIMIT;
nuclear@0 203 };
nuclear@0 204
nuclear@0 205 } // end of namespace Assimp
nuclear@0 206
nuclear@0 207 #endif // !!AI_SPLITLARGEMESHES_H_INC