hkaWaveletCompressedAnimation.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:10k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* 
  2.  * 
  3.  * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
  4.  * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
  5.  * Level 2 and Level 3 source code contains trade secrets of Havok. Havok Software (C) Copyright 1999-2009 Telekinesys Research Limited t/a Havok. All Rights Reserved. Use of this software is subject to the terms of an end user license agreement.
  6.  * 
  7.  */
  8. #ifndef HKANIMATION_ANIMATION_WAVELETCOMPRESSED_HKWAVELETCOMPRESSEDANIMATION_XML_H
  9. #define HKANIMATION_ANIMATION_WAVELETCOMPRESSED_HKWAVELETCOMPRESSEDANIMATION_XML_H
  10. #include <Animation/Animation/Animation/hkaAnimation.h>
  11. /// hkaWaveletCompressedAnimation meta information
  12. extern const class hkClass hkaWaveletCompressedAnimationClass;
  13. class hkaInterleavedUncompressedAnimation;
  14. /// Compresses animation data using a wavelet transform.
  15. /// See Animation Compression section of the Userguide for details.
  16. class hkaWaveletCompressedAnimation : public hkaAnimation
  17. {
  18. public:
  19. HK_DECLARE_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIM_COMPRESSED );
  20. HK_DECLARE_REFLECTION();
  21. /// Compression parameters
  22. struct CompressionParams
  23. {
  24. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIM_COMPRESSED, hkaWaveletCompressedAnimation::CompressionParams );
  25. HK_DECLARE_REFLECTION();
  26. /// Bits used for float quantization - default 8, range [2,16]
  27. hkUint16 m_quantizationBits;
  28. /// Block size - default 65535
  29. hkUint16 m_blockSize;
  30. /// (INTERNAL) Allows exact preservation (full 4-bytes floats) of the first 'n' floats during the quantization process - default 'false' 
  31. hkUint16 m_preserve;
  32. /// If m_useOldStyleTruncation (deprecated) is set to 'true', this is the fraction of wavelet coefficients discarded (set to zero) - default 0.1
  33. hkReal   m_truncProp;
  34. /// Allows backwards compatability (see m_truncProp) - default 'false'
  35. hkBool   m_useOldStyleTruncation;
  36. /// TrackAnalysis absolute position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.0
  37. hkReal m_absolutePositionTolerance; // Set to 0 to use only relative tolerance
  38. /// TrackAnalysis relative position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.01
  39. hkReal m_relativePositionTolerance; // Set to 0 to use only abs tolerance
  40. /// TrackAnalysis rotation position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.001
  41. hkReal m_rotationTolerance;
  42. /// TrackAnalysis scale position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.01
  43. hkReal m_scaleTolerance;
  44. /// TrackAnalysis float tolerance. See the "Compression Overview" section of the Userguide for details - default 0.001
  45. hkReal m_absoluteFloatTolerance;
  46. CompressionParams();
  47. };
  48. /// This structure is used when specifying per track compression settings
  49. struct PerTrackCompressionParams
  50. {
  51. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIM_COMPRESSED, hkaWaveletCompressedAnimation::PerTrackCompressionParams );
  52. /// List of CompressionParams to enable per-bone compression settings
  53. /// On initialisation only a single element is allocated. 
  54. hkArray<struct hkaWaveletCompressedAnimation::CompressionParams> m_parameterPalette;
  55. /// An array of indices into the palette above for transform tracks 
  56. hkArray<int> m_trackIndexToPaletteIndex;
  57. /// An array of indices into the palette above for float tracks 
  58. hkArray<int> m_floatTrackIndexToPaletteIndex;
  59. };
  60. /// Constructor compresses data
  61. hkaWaveletCompressedAnimation(const hkaInterleavedUncompressedAnimation& raw, const CompressionParams& params, hkBool useThreeComponentQuaternions = true );
  62.     /// Constructor allowing different compression settings for each track in the animation
  63. hkaWaveletCompressedAnimation(const hkaInterleavedUncompressedAnimation& raw, const PerTrackCompressionParams& params, hkBool useThreeComponentQuaternions = true );
  64. /// Get the tracks at a given time
  65. /// Note: If you are calling this method directly you may find some quantization error present in the rotations.
  66. /// The blending done in hkaAnimatedSkeleton is not sensitive to rotation error so rather than renormalize here
  67. /// we defer it until blending has been completed. If you are using this method directly you may want to call 
  68. /// hkaSkeletonUtils::normalizeRotations() on the results.
  69. virtual void sampleTracks(hkReal time, hkQsTransform* transformTracksOut, hkReal* floatTracksOut, hkaChunkCache* cache) const;
  70. /// Get a subset of the the first 'maxNumTracks' tracks of a pose at a given time (all tracks from 0 to maxNumTracks-1 inclusive).
  71. virtual void samplePartialTracks(hkReal time,
  72.  hkUint32 maxNumTransformTracks, hkQsTransform* transformTracksOut,
  73.  hkUint32 maxNumFloatTracks, hkReal* floatTracksOut,
  74.  hkaChunkCache* cache) const;
  75. /// Sample individual animation tracks
  76. virtual void sampleIndividualTransformTracks( hkReal time, const hkInt16* tracks, hkUint32 numTracks, hkQsTransform* transformOut ) const;
  77. /// Sample a individual floating tracks
  78. virtual void sampleIndividualFloatTracks( hkReal time, const hkInt16* tracks, hkUint32 numTracks, hkReal* out ) const;
  79. /// Returns the number of original samples / frames of animation
  80. virtual int getNumOriginalFrames() const;
  81. /// Get a key for use with the cache
  82. virtual hkUint32 getFullCacheKey( hkUint32 poseIdx ) const;
  83. /// Clear the cache of all keys associated with this animation - use to 'unload' an animation from the cache
  84. virtual void clearAllCacheKeys(hkaChunkCache* cache) const;
  85. /*
  86. * Block decompression
  87. */
  88. /// Return the number of chunks of data required to sample the tracks at time t
  89. virtual int getNumDataChunks(hkReal time) const;
  90. /// Return the chunks of data required to sample the tracks at time t
  91. virtual void getDataChunks(hkReal time, DataChunk* dataChunks, int numDataChunks) const;
  92. /// Return the maximum total size of all chunk data which could be returned by getDataChunks for this animation.
  93. virtual int getMaxSizeOfCombinedDataChunks() const;
  94. /// Get a subset of the tracks a given time using data chunks. Sample is calculated using pose[frameIndex] * (1 - frameDelta) + pose[frameIndex+1] * frameDelta.
  95. static void HK_CALL samplePartialWithDataChunks(hkUint32 frameIndex, hkReal frameDelta, 
  96. hkUint32 maxNumTransformTracks, hkQsTransform* transformTracksOut,
  97. hkUint32 maxNumFloatTracks, hkReal* floatTracksOut,
  98. const DataChunk* dataChunks, int numDataChunks);
  99. void getBlockDataAndSize(int blockNum, DataChunk& dataChunkOut) const;
  100. public:
  101. /// The number of samples encoded in the animation.
  102. int m_numberOfPoses;
  103. /// The number of tracks in each encoded block
  104. int m_blockSize;
  105. /// 
  106. struct QuantizationFormat
  107. {
  108. HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIMATION, hkaWaveletCompressedAnimation::QuantizationFormat );
  109. HK_DECLARE_REFLECTION();
  110. QuantizationFormat( ) { }
  111. QuantizationFormat( hkFinishLoadedObjectFlag flag ) {} 
  112. // Backwards compatibility only - pre-per-track compression.
  113. hkUint8 m_maxBitWidth;
  114. // Always 0 for wavelet since all coefficients are quantized (none preserved).
  115. hkUint8 m_preserved;
  116. // Number of dynamic tracks that are quantized and stored
  117. hkUint32 m_numD;
  118. // Index into the data buffer for the quantization offsets
  119. hkUint32 m_offsetIdx;
  120. // Index into the data buffer for the quantization scales
  121. hkUint32 m_scaleIdx;
  122. // Index into the data buffer for the quantization bidwidths
  123. hkUint32 m_bitWidthIdx;
  124. };
  125. /// Quantization Description
  126. struct QuantizationFormat m_qFormat;
  127. /// Index into the data buffer for the Track Mask
  128. hkUint32 m_staticMaskIdx;
  129. /// Index into the data buffer for the Static DOF Data
  130. hkUint32 m_staticDOFsIdx;
  131. /// Number Static Transform DOFs
  132. hkUint32 m_numStaticTransformDOFs;
  133. /// Number Dynamic Transform DOFs
  134. hkUint32 m_numDynamicTransformDOFs;
  135. /// Index into the data buffer for the block indices
  136. hkUint32 m_blockIndexIdx;
  137. /// Size of the block indices (stored as hkUint32)
  138. hkUint32 m_blockIndexSize;
  139. /// Index into the data buffer for the Quantization Data
  140. hkUint32 m_quantizedDataIdx;
  141. /// Size of the Quantization Data (stored as hkUint8)
  142. hkUint32 m_quantizedDataSize;
  143. /// The data buffer where compressed and static data is kept
  144. hkUint8* m_dataBuffer;
  145. int  m_numDataBuffer;
  146. public:
  147. // Constructor for initialisation of vtable fixup
  148. HK_FORCE_INLINE hkaWaveletCompressedAnimation( hkFinishLoadedObjectFlag flag ) : hkaAnimation(flag),
  149. m_qFormat(flag) { if (flag.m_finishing) handleEndian(); }
  150. ~hkaWaveletCompressedAnimation();
  151. private:
  152. /// Initialize the animation with construction info
  153. void initialize(const hkaInterleavedUncompressedAnimation& raw, const PerTrackCompressionParams& params, hkBool useThreeComponentQuaternions);
  154. /// Swap the endianness in the data buffer as appropriate
  155. void handleEndian();
  156. };
  157. #endif // HKANIMATION_ANIMATION_WAVELETCOMPRESSED_HKWAVELETCOMPRESSEDANIMATION_XML_H
  158. /*
  159. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  160. * Confidential Information of Havok.  (C) Copyright 1999-2009
  161. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  162. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  163. * rights, and intellectual property rights in the Havok software remain in
  164. * Havok and/or its suppliers.
  165. * Use of this software for evaluation purposes is subject to and indicates
  166. * acceptance of the End User licence Agreement for this product. A copy of
  167. * the license is included with this software and is also available at www.havok.com/tryhavok.
  168. */