XII Release 0.1.0
Loading...
Searching...
No Matches
xiiMsgAnimationPoseGeneration Struct Reference

Sent to objects when a parent component is generating an animation pose, to inject additional pose commands, for instance to apply inverse kinematics (IK). More...

#include <Declarations.h>

Inheritance diagram for xiiMsgAnimationPoseGeneration:
[legend]

Public Member Functions

 XII_DECLARE_MESSAGE_TYPE (xiiMsgAnimationPoseGeneration, xiiMessage)
 
- Public Member Functions inherited from xiiMessage
virtual xiiInt32 GetSortingKey () const
 Derived message types can override this method to influence sorting order. Smaller keys are processed first.
 
XII_ALWAYS_INLINE xiiMessageId GetId () const
 Returns the id for this message type.
 
XII_ALWAYS_INLINE xiiUInt16 GetSize () const
 Returns the size in byte of this message.
 
XII_ALWAYS_INLINE xiiUInt64 GetHash () const
 Calculates a hash of the message.
 
virtual void Serialize (xiiStreamWriter &ref_stream) const
 Implement this for efficient transmission across process boundaries (e.g. network transfer etc.)
 
virtual void Deserialize (xiiStreamReader &ref_stream, xiiUInt8 uiTypeVersion)
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Public Attributes

xiiAnimPoseGeneratorm_pGenerator = nullptr
 

Additional Inherited Members

- Static Public Member Functions inherited from xiiMessage
static void PackageForTransfer (const xiiMessage &msg, xiiStreamWriter &ref_stream)
 Writes msg to stream in such a way that ReplicatePackedMessage() can restore it even in another process.
 
static xiiUniquePtr< xiiMessageReplicatePackedMessage (xiiStreamReader &ref_stream)
 Restores a message that was written by PackageForTransfer()
 
- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTIGetStaticRTTI ()
 
- Protected Member Functions inherited from xiiMessage
 xiiMessage (size_t messageSize)
 
- Static Protected Member Functions inherited from xiiMessage
static XII_ALWAYS_INLINE xiiMessageId GetNextMsgId ()
 
- Protected Attributes inherited from xiiMessage
xiiMessageId m_Id
 
xiiUInt16 m_uiSize
 
- Static Protected Attributes inherited from xiiMessage
static xiiMessageId s_NextMsgId = 0
 

Detailed Description

Sent to objects when a parent component is generating an animation pose, to inject additional pose commands, for instance to apply inverse kinematics (IK).

The message contains the xiiAnimPoseGenerator that is currently being built. Usually it has already been executed once and generated a pose (in model space), which can be queried to build upon. Additional commands can then be added to modify the pose. This is mainly meant for inverse kinematics use cases.


The documentation for this struct was generated from the following file: