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