vrshoot
view libs/assimp/LimitBoneWeightsProcess.h @ 0:b2f14e535253
initial commit
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Sat, 01 Feb 2014 19:58:19 +0200 |
| parents | |
| children |
line source
1 /*
2 Open Asset Import Library (assimp)
3 ----------------------------------------------------------------------
5 Copyright (c) 2006-2012, assimp team
6 All rights reserved.
8 Redistribution and use of this software in source and binary forms,
9 with or without modification, are permitted provided that the
10 following conditions are met:
12 * Redistributions of source code must retain the above
13 copyright notice, this list of conditions and the
14 following disclaimer.
16 * Redistributions in binary form must reproduce the above
17 copyright notice, this list of conditions and the
18 following disclaimer in the documentation and/or other
19 materials provided with the distribution.
21 * Neither the name of the assimp team, nor the names of its
22 contributors may be used to endorse or promote products
23 derived from this software without specific prior
24 written permission of the assimp team.
26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 ----------------------------------------------------------------------
39 */
41 /** Defines a post processing step to limit the number of bones affecting a single vertex. */
42 #ifndef AI_LIMITBONEWEIGHTSPROCESS_H_INC
43 #define AI_LIMITBONEWEIGHTSPROCESS_H_INC
45 #include "BaseProcess.h"
47 struct aiMesh;
48 class LimitBoneWeightsTest;
50 namespace Assimp
51 {
53 // NOTE: If you change these limits, don't forget to change the
54 // corresponding values in all Assimp ports
56 // **********************************************************
57 // Java: ConfigProperty.java,
58 // ConfigProperty.DEFAULT_BONE_WEIGHT_LIMIT
59 // **********************************************************
61 #if (!defined AI_LMW_MAX_WEIGHTS)
62 # define AI_LMW_MAX_WEIGHTS 0x4
63 #endif // !! AI_LMW_MAX_WEIGHTS
65 // ---------------------------------------------------------------------------
66 /** This post processing step limits the number of bones affecting a vertex
67 * to a certain maximum value. If a vertex is affected by more than that number
68 * of bones, the bone weight with the least influence on this vertex are removed.
69 * The other weights on this bone are then renormalized to assure the sum weight
70 * to be 1.
71 */
72 class LimitBoneWeightsProcess : public BaseProcess
73 {
74 public:
76 LimitBoneWeightsProcess();
77 ~LimitBoneWeightsProcess();
79 public:
80 // -------------------------------------------------------------------
81 /** Returns whether the processing step is present in the given flag.
82 * @param pFlags The processing flags the importer was called with.
83 * A bitwise combination of #aiPostProcessSteps.
84 * @return true if the process is present in this flag fields,
85 * false if not.
86 */
87 bool IsActive( unsigned int pFlags) const;
89 // -------------------------------------------------------------------
90 /** Called prior to ExecuteOnScene().
91 * The function is a request to the process to update its configuration
92 * basing on the Importer's configuration property list.
93 */
94 void SetupProperties(const Importer* pImp);
96 public:
98 // -------------------------------------------------------------------
99 /** Limits the bone weight count for all vertices in the given mesh.
100 * @param pMesh The mesh to process.
101 */
102 void ProcessMesh( aiMesh* pMesh);
104 // -------------------------------------------------------------------
105 /** Executes the post processing step on the given imported data.
106 * At the moment a process is not supposed to fail.
107 * @param pScene The imported data to work at.
108 */
109 void Execute( aiScene* pScene);
112 public:
114 // -------------------------------------------------------------------
115 /** Describes a bone weight on a vertex */
116 struct Weight
117 {
118 unsigned int mBone; ///< Index of the bone
119 float mWeight; ///< Weight of that bone on this vertex
120 Weight() { }
121 Weight( unsigned int pBone, float pWeight)
122 {
123 mBone = pBone;
124 mWeight = pWeight;
125 }
127 /** Comparision operator to sort bone weights by descending weight */
128 bool operator < (const Weight& pWeight) const
129 {
130 return mWeight > pWeight.mWeight;
131 }
132 };
134 public:
135 /** Maximum number of bones influencing any single vertex. */
136 unsigned int mMaxWeights;
137 };
139 } // end of namespace Assimp
141 #endif // AI_LIMITBONEWEIGHTSPROCESS_H_INC