hkaWaveletCompressedAnimation.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:10k
源码类别:
其他游戏
开发平台:
Visual C++
- /*
- *
- * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
- * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
- * 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.
- *
- */
- #ifndef HKANIMATION_ANIMATION_WAVELETCOMPRESSED_HKWAVELETCOMPRESSEDANIMATION_XML_H
- #define HKANIMATION_ANIMATION_WAVELETCOMPRESSED_HKWAVELETCOMPRESSEDANIMATION_XML_H
- #include <Animation/Animation/Animation/hkaAnimation.h>
- /// hkaWaveletCompressedAnimation meta information
- extern const class hkClass hkaWaveletCompressedAnimationClass;
- class hkaInterleavedUncompressedAnimation;
- /// Compresses animation data using a wavelet transform.
- /// See Animation Compression section of the Userguide for details.
- class hkaWaveletCompressedAnimation : public hkaAnimation
- {
- public:
- HK_DECLARE_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIM_COMPRESSED );
- HK_DECLARE_REFLECTION();
- /// Compression parameters
- struct CompressionParams
- {
- HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIM_COMPRESSED, hkaWaveletCompressedAnimation::CompressionParams );
- HK_DECLARE_REFLECTION();
- /// Bits used for float quantization - default 8, range [2,16]
- hkUint16 m_quantizationBits;
- /// Block size - default 65535
- hkUint16 m_blockSize;
- /// (INTERNAL) Allows exact preservation (full 4-bytes floats) of the first 'n' floats during the quantization process - default 'false'
- hkUint16 m_preserve;
- /// If m_useOldStyleTruncation (deprecated) is set to 'true', this is the fraction of wavelet coefficients discarded (set to zero) - default 0.1
- hkReal m_truncProp;
- /// Allows backwards compatability (see m_truncProp) - default 'false'
- hkBool m_useOldStyleTruncation;
- /// TrackAnalysis absolute position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.0
- hkReal m_absolutePositionTolerance; // Set to 0 to use only relative tolerance
- /// TrackAnalysis relative position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.01
- hkReal m_relativePositionTolerance; // Set to 0 to use only abs tolerance
- /// TrackAnalysis rotation position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.001
- hkReal m_rotationTolerance;
- /// TrackAnalysis scale position tolerance. See the "Compression Overview" section of the Userguide for details - default 0.01
- hkReal m_scaleTolerance;
- /// TrackAnalysis float tolerance. See the "Compression Overview" section of the Userguide for details - default 0.001
- hkReal m_absoluteFloatTolerance;
- CompressionParams();
- };
- /// This structure is used when specifying per track compression settings
- struct PerTrackCompressionParams
- {
- HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIM_COMPRESSED, hkaWaveletCompressedAnimation::PerTrackCompressionParams );
- /// List of CompressionParams to enable per-bone compression settings
- /// On initialisation only a single element is allocated.
- hkArray<struct hkaWaveletCompressedAnimation::CompressionParams> m_parameterPalette;
- /// An array of indices into the palette above for transform tracks
- hkArray<int> m_trackIndexToPaletteIndex;
- /// An array of indices into the palette above for float tracks
- hkArray<int> m_floatTrackIndexToPaletteIndex;
- };
- /// Constructor compresses data
- hkaWaveletCompressedAnimation(const hkaInterleavedUncompressedAnimation& raw, const CompressionParams& params, hkBool useThreeComponentQuaternions = true );
- /// Constructor allowing different compression settings for each track in the animation
- hkaWaveletCompressedAnimation(const hkaInterleavedUncompressedAnimation& raw, const PerTrackCompressionParams& params, hkBool useThreeComponentQuaternions = true );
- /// Get the tracks at a given time
- /// Note: If you are calling this method directly you may find some quantization error present in the rotations.
- /// The blending done in hkaAnimatedSkeleton is not sensitive to rotation error so rather than renormalize here
- /// we defer it until blending has been completed. If you are using this method directly you may want to call
- /// hkaSkeletonUtils::normalizeRotations() on the results.
- virtual void sampleTracks(hkReal time, hkQsTransform* transformTracksOut, hkReal* floatTracksOut, hkaChunkCache* cache) const;
- /// Get a subset of the the first 'maxNumTracks' tracks of a pose at a given time (all tracks from 0 to maxNumTracks-1 inclusive).
- virtual void samplePartialTracks(hkReal time,
- hkUint32 maxNumTransformTracks, hkQsTransform* transformTracksOut,
- hkUint32 maxNumFloatTracks, hkReal* floatTracksOut,
- hkaChunkCache* cache) const;
- /// Sample individual animation tracks
- virtual void sampleIndividualTransformTracks( hkReal time, const hkInt16* tracks, hkUint32 numTracks, hkQsTransform* transformOut ) const;
- /// Sample a individual floating tracks
- virtual void sampleIndividualFloatTracks( hkReal time, const hkInt16* tracks, hkUint32 numTracks, hkReal* out ) const;
- /// Returns the number of original samples / frames of animation
- virtual int getNumOriginalFrames() const;
- /// Get a key for use with the cache
- virtual hkUint32 getFullCacheKey( hkUint32 poseIdx ) const;
- /// Clear the cache of all keys associated with this animation - use to 'unload' an animation from the cache
- virtual void clearAllCacheKeys(hkaChunkCache* cache) const;
- /*
- * Block decompression
- */
- /// Return the number of chunks of data required to sample the tracks at time t
- virtual int getNumDataChunks(hkReal time) const;
- /// Return the chunks of data required to sample the tracks at time t
- virtual void getDataChunks(hkReal time, DataChunk* dataChunks, int numDataChunks) const;
- /// Return the maximum total size of all chunk data which could be returned by getDataChunks for this animation.
- virtual int getMaxSizeOfCombinedDataChunks() const;
- /// Get a subset of the tracks a given time using data chunks. Sample is calculated using pose[frameIndex] * (1 - frameDelta) + pose[frameIndex+1] * frameDelta.
- static void HK_CALL samplePartialWithDataChunks(hkUint32 frameIndex, hkReal frameDelta,
- hkUint32 maxNumTransformTracks, hkQsTransform* transformTracksOut,
- hkUint32 maxNumFloatTracks, hkReal* floatTracksOut,
- const DataChunk* dataChunks, int numDataChunks);
- void getBlockDataAndSize(int blockNum, DataChunk& dataChunkOut) const;
- public:
- /// The number of samples encoded in the animation.
- int m_numberOfPoses;
- /// The number of tracks in each encoded block
- int m_blockSize;
- ///
- struct QuantizationFormat
- {
- HK_DECLARE_NONVIRTUAL_CLASS_ALLOCATOR( HK_MEMORY_CLASS_ANIMATION, hkaWaveletCompressedAnimation::QuantizationFormat );
- HK_DECLARE_REFLECTION();
- QuantizationFormat( ) { }
- QuantizationFormat( hkFinishLoadedObjectFlag flag ) {}
- // Backwards compatibility only - pre-per-track compression.
- hkUint8 m_maxBitWidth;
- // Always 0 for wavelet since all coefficients are quantized (none preserved).
- hkUint8 m_preserved;
- // Number of dynamic tracks that are quantized and stored
- hkUint32 m_numD;
- // Index into the data buffer for the quantization offsets
- hkUint32 m_offsetIdx;
- // Index into the data buffer for the quantization scales
- hkUint32 m_scaleIdx;
- // Index into the data buffer for the quantization bidwidths
- hkUint32 m_bitWidthIdx;
- };
- /// Quantization Description
- struct QuantizationFormat m_qFormat;
- /// Index into the data buffer for the Track Mask
- hkUint32 m_staticMaskIdx;
- /// Index into the data buffer for the Static DOF Data
- hkUint32 m_staticDOFsIdx;
- /// Number Static Transform DOFs
- hkUint32 m_numStaticTransformDOFs;
- /// Number Dynamic Transform DOFs
- hkUint32 m_numDynamicTransformDOFs;
- /// Index into the data buffer for the block indices
- hkUint32 m_blockIndexIdx;
- /// Size of the block indices (stored as hkUint32)
- hkUint32 m_blockIndexSize;
- /// Index into the data buffer for the Quantization Data
- hkUint32 m_quantizedDataIdx;
- /// Size of the Quantization Data (stored as hkUint8)
- hkUint32 m_quantizedDataSize;
- /// The data buffer where compressed and static data is kept
- hkUint8* m_dataBuffer;
- int m_numDataBuffer;
- public:
- // Constructor for initialisation of vtable fixup
- HK_FORCE_INLINE hkaWaveletCompressedAnimation( hkFinishLoadedObjectFlag flag ) : hkaAnimation(flag),
- m_qFormat(flag) { if (flag.m_finishing) handleEndian(); }
- ~hkaWaveletCompressedAnimation();
- private:
- /// Initialize the animation with construction info
- void initialize(const hkaInterleavedUncompressedAnimation& raw, const PerTrackCompressionParams& params, hkBool useThreeComponentQuaternions);
- /// Swap the endianness in the data buffer as appropriate
- void handleEndian();
- };
- #endif // HKANIMATION_ANIMATION_WAVELETCOMPRESSED_HKWAVELETCOMPRESSEDANIMATION_XML_H
- /*
- * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
- *
- * Confidential Information of Havok. (C) Copyright 1999-2009
- * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
- * Logo, and the Havok buzzsaw logo are trademarks of Havok. Title, ownership
- * rights, and intellectual property rights in the Havok software remain in
- * Havok and/or its suppliers.
- *
- * Use of this software for evaluation purposes is subject to and indicates
- * acceptance of the End User licence Agreement for this product. A copy of
- * the license is included with this software and is also available at www.havok.com/tryhavok.
- *
- */