1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 Permission is hereby granted, free of charge, to any person obtaining a copy
9 of this software and associated documentation files (the "Software"), to deal
10 in the Software without restriction, including without limitation the rights
11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 copies of the Software, and to permit persons to whom the Software is
13 furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16 all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 THE SOFTWARE.
25 -----------------------------------------------------------------------------
26 */
27 #ifndef _ShaderExDualQuaternionSkinning_
28 #define _ShaderExDualQuaternionSkinning_
29 
30 #include "OgreShaderPrerequisites.h"
31 
32 #ifdef RTSHADER_SYSTEM_BUILD_EXT_SHADERS
33 #include "OgreShaderExHardwareSkinningTechnique.h"
34 #include "OgreShaderParameter.h"
35 #include "OgreRenderSystem.h"
36 #include "OgreShaderFunctionAtom.h"
37 
38 namespace Ogre {
39 namespace RTShader {
40 
41 /** \addtogroup Core
42 *  @{
43 */
44 /** \addtogroup RTShader
45 *  @{
46 */
47 
48 #define SGX_LIB_DUAL_QUATERNION                 "SGXLib_DualQuaternion"
49 #define SGX_FUNC_BLEND_WEIGHT                   "SGX_BlendWeight"
50 #define SGX_FUNC_ANTIPODALITY_ADJUSTMENT        "SGX_AntipodalityAdjustment"
51 #define SGX_FUNC_CALCULATE_BLEND_POSITION       "SGX_CalculateBlendPosition"
52 #define SGX_FUNC_CALCULATE_BLEND_NORMAL         "SGX_CalculateBlendNormal"
53 #define SGX_FUNC_NORMALIZE_DUAL_QUATERNION      "SGX_NormalizeDualQuaternion"
54 #define SGX_FUNC_ADJOINT_TRANSPOSE_MATRIX       "SGX_AdjointTransposeMatrix"
55 #define SGX_FUNC_BUILD_DUAL_QUATERNION_MATRIX   "SGX_BuildDualQuaternionMatrix"
56 
57 /** Implement a sub render state which performs dual quaternion hardware skinning.
58     This sub render state uses bone matrices converted to dual quaternions and adds calculations
59     to transform the points and normals using their associated dual quaternions.
60 */
61 class _OgreRTSSExport DualQuaternionSkinning : public HardwareSkinningTechnique
62 {
63 // Interface.
64 public:
65     /** Class default constructor */
66     DualQuaternionSkinning();
67 
68 	/**
69 	@see SubRenderState::resolveParameters.
70 	*/
71 	virtual bool resolveParameters(ProgramSet* programSet);
72 
73 	/**
74 	@see SubRenderState::resolveDependencies.
75 	*/
76 	virtual bool resolveDependencies(ProgramSet* programSet);
77 
78 	/**
79 	@see SubRenderState::addFunctionInvocations.
80 	*/
81 	virtual bool addFunctionInvocations(ProgramSet* programSet);
82 
83 // Protected methods
84 protected:
85     /** Adds functions to calculate position data in world, object and projective space */
86     void addPositionCalculations(Function* vsMain, int& funcCounter);
87 
88     /** Adjusts the sign of a dual quaternion depending on its orientation to the root dual quaternion */
89     void adjustForCorrectAntipodality(Function* vsMain, int index, int& funcCounter, const ParameterPtr& pTempWorldMatrix);
90 
91     /** Adds the weight of a given position for a given index
92     @param pPositionTempParameter
93         Requires a temp parameter with a matrix the same size of pPositionRelatedParam
94     */
95     void addIndexedPositionWeight(Function* vsMain, int index, ParameterPtr& pWorldMatrix,
96                                   ParameterPtr& pPositionTempParameter, ParameterPtr& pPositionRelatedOutputParam, int& funcCounter);
97 
98     /** Adds the calculations for calculating a normal related element */
99     void addNormalRelatedCalculations(Function* vsMain,
100                                       ParameterPtr& pNormalRelatedParam,
101                                       ParameterPtr& pNormalWorldRelatedParam,
102                                       int& funcCounter);
103 
104 protected:
105     UniformParameterPtr mParamInScaleShearMatrices;
106     ParameterPtr mParamLocalBlendPosition;
107     ParameterPtr mParamBlendS;
108     ParameterPtr mParamBlendDQ;
109     ParameterPtr mParamInitialDQ;
110     ParameterPtr mParamTempWorldMatrix;
111 
112     ParameterPtr mParamTempFloat2x4;
113     ParameterPtr mParamTempFloat3x3;
114     ParameterPtr mParamTempFloat3x4;
115 
116     ParameterPtr mParamIndex1;
117     ParameterPtr mParamIndex2;
118 
119 };
120 
121 } // namespace RTShader
122 } // namespace Ogre
123 
124 #endif // RTSHADER_SYSTEM_BUILD_EXT_SHADERS
125 #endif // _ShaderExDualQuaternionSkinning_
126 
127