vrshoot

annotate libs/assimp/DeboneProcess.h @ 1:e7ca128b8713

looks nice :)
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 02 Feb 2014 00:35:22 +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 /** Defines a post processing step to limit the number of bones affecting a single vertex. */
nuclear@0 42 #ifndef AI_DEBONEPROCESS_H_INC
nuclear@0 43 #define AI_DEBONEPROCESS_H_INC
nuclear@0 44
nuclear@0 45 #include <vector>
nuclear@0 46 #include <utility>
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 DeboneTest;
nuclear@0 53
nuclear@0 54 namespace Assimp
nuclear@0 55 {
nuclear@0 56
nuclear@0 57 #if (!defined AI_DEBONE_THRESHOLD)
nuclear@0 58 # define AI_DEBONE_THRESHOLD 1.0f
nuclear@0 59 #endif // !! AI_DEBONE_THRESHOLD
nuclear@0 60
nuclear@0 61 // ---------------------------------------------------------------------------
nuclear@0 62 /** This post processing step removes bones nearly losslessly or according to
nuclear@0 63 * a configured threshold. In order to remove the bone, the primitives affected by
nuclear@0 64 * the bone are split from the mesh. The split off (new) mesh is boneless. At any
nuclear@0 65 * point in time, bones without affect upon a given mesh are to be removed.
nuclear@0 66 */
nuclear@0 67 class DeboneProcess : public BaseProcess
nuclear@0 68 {
nuclear@0 69 public:
nuclear@0 70
nuclear@0 71 DeboneProcess();
nuclear@0 72 ~DeboneProcess();
nuclear@0 73
nuclear@0 74 public:
nuclear@0 75 // -------------------------------------------------------------------
nuclear@0 76 /** Returns whether the processing step is present in the given flag.
nuclear@0 77 * @param pFlags The processing flags the importer was called with.
nuclear@0 78 * A bitwise combination of #aiPostProcessSteps.
nuclear@0 79 * @return true if the process is present in this flag fields,
nuclear@0 80 * false if not.
nuclear@0 81 */
nuclear@0 82 bool IsActive( unsigned int pFlags) const;
nuclear@0 83
nuclear@0 84 // -------------------------------------------------------------------
nuclear@0 85 /** Called prior to ExecuteOnScene().
nuclear@0 86 * The function is a request to the process to update its configuration
nuclear@0 87 * basing on the Importer's configuration property list.
nuclear@0 88 */
nuclear@0 89 void SetupProperties(const Importer* pImp);
nuclear@0 90
nuclear@0 91 protected:
nuclear@0 92
nuclear@0 93 // -------------------------------------------------------------------
nuclear@0 94 /** Executes the post processing step on the given imported data.
nuclear@0 95 * At the moment a process is not supposed to fail.
nuclear@0 96 * @param pScene The imported data to work at.
nuclear@0 97 */
nuclear@0 98 void Execute( aiScene* pScene);
nuclear@0 99
nuclear@0 100 // -------------------------------------------------------------------
nuclear@0 101 /** Counts bones total/removable in a given mesh.
nuclear@0 102 * @param pMesh The mesh to process.
nuclear@0 103 */
nuclear@0 104 bool ConsiderMesh( const aiMesh* pMesh);
nuclear@0 105
nuclear@0 106 /// Splits the given mesh by bone count.
nuclear@0 107 /// @param pMesh the Mesh to split. Is not changed at all, but might be superfluous in case it was split.
nuclear@0 108 /// @param poNewMeshes Array of submeshes created in the process. Empty if splitting was not necessary.
nuclear@0 109 void SplitMesh(const aiMesh* pMesh, std::vector< std::pair< aiMesh*,const aiBone* > >& poNewMeshes) const;
nuclear@0 110
nuclear@0 111 /// Recursively updates the node's mesh list to account for the changed mesh list
nuclear@0 112 void UpdateNode(aiNode* pNode) const;
nuclear@0 113
nuclear@0 114 // -------------------------------------------------------------------
nuclear@0 115 // Apply transformation to a mesh
nuclear@0 116 void ApplyTransform(aiMesh* mesh, const aiMatrix4x4& mat)const;
nuclear@0 117
nuclear@0 118 public:
nuclear@0 119 /** Number of bones present in the scene. */
nuclear@0 120 unsigned int mNumBones;
nuclear@0 121 unsigned int mNumBonesCanDoWithout;
nuclear@0 122
nuclear@0 123 float mThreshold;
nuclear@0 124 bool mAllOrNone;
nuclear@0 125
nuclear@0 126 /// Per mesh index: Array of indices of the new submeshes.
nuclear@0 127 std::vector< std::vector< std::pair< unsigned int,aiNode* > > > mSubMeshIndices;
nuclear@0 128 };
nuclear@0 129
nuclear@0 130 } // end of namespace Assimp
nuclear@0 131
nuclear@0 132 #endif // AI_DEBONEPROCESS_H_INC