DtCigiDiGuyCtrlExt.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2017 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/


#pragma once

#include <makCigiExtensions/makCigiExtensions.h>

#include "CigiBaseVariableSizePckt.h"

#include <string>


//+> Packet layout
// |-------------------------------------------------------------------------------------------------------------------------------|
// | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
// |-------------------------------------------------------------------------------------------------------------------------------|
// |    Packet Id = 201            |   Packet Size = 16+strLen     |                            Entity ID                          |
// |-------------------------------------------------------------------------------------------------------------------------------|
// | Reserved  |  *4   | *3| *2| *1|Res|*11|*10| *9| *8| *7| *6| *5|                            Reserved                           |
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                                         X Scale                                                               |                                                          
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                                         Y Scale                                                               |                                                          
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                                         Z Scale                                                               |                                                          
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                                          Weight                                                               |                                                          
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                                     Animation speed                                                           |
// |                                                                                                                               |
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                            Animation (variable, multiple of 8 bytes)                                          |                                                          
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                            Item Appearance (variable, multiple of 8 bytes)                                    |                                                          
// |-------------------------------------------------------------------------------------------------------------------------------|
// |                                            Head Appearance (variable, multiple of 8 bytes)                                    |                                                          
// |_______________________________________________________________________________________________________________________________|

// *1 Action Paused
// *2 Weapon State
// *3 Health State
// *4 Posture  
// *5 Action Paused Enable
// *6 Weapon State Enable
// *7 Posture Enable
// *8 Animation Speed Enable
// *9 Health State Enable
// *10 Scale Enable
// *11 Weight Enable
//
namespace makCigiExt
{

   const int CIGI_DI_GUY_CTRL_EXT_PACKET_ID = 202;

   // This is the size of the FIXED portion of the packet
   const int CIGI_DI_GUY_CTRL_EXT_PACKET_SIZE = 32;

   //=========================================================
   class DT_DLL_MAKCIGIEXTENSIONS DtCigiDiGuyCtrlExt :
      public CigiBaseVariableSizePckt
   {
   public:
      //=========================================================
      enum AnimationStateGrp
      {
         Unpaused=0,
         Paused=1
      };

      //=========================================================
      enum WeaponStateGrp
      {
         Stowed=0, 
         Deployed=1 
      };

      //=========================================================
      enum PostureGrp
      {
         Standing=0, 
         Sitting=1, 
         Crouched=2, 
         Prone=3
      };

      //=========================================================
      enum HealthStateGrp
      {
         Alive=0,
         Dead=1
      };

      //==> Management

      //=========================================================
      DtCigiDiGuyCtrlExt(void);

      //=========================================================
      virtual ~DtCigiDiGuyCtrlExt(void);

      //=========================================================
      DtCigiDiGuyCtrlExt(const DtCigiDiGuyCtrlExt &BaseIn);

      //=========================================================
      DtCigiDiGuyCtrlExt& operator=(const DtCigiDiGuyCtrlExt& BaseIn);

      //==> Buffer Packing/Unpacking

      //=========================================================
      virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const;

      //=========================================================
      virtual int Unpack(Cigi_uint8 * Buff, bool Swap, void *Spec);

      //=========================================================
      virtual int GetTruePacketSize(CigiBaseVariableSizePckt &refPacket)
      { return(PacketSize + refPacket.GetVariableDataSize()); }

      //==> Accessing Member Variable Values functions

      //+> EntityID

      //=========================================================
      int SetEntityID(const Cigi_uint16 EntityIDIn, bool bndchk=true)
      {
         myEntityID = EntityIDIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      Cigi_uint16 GetEntityID(void) const { return(myEntityID); }

      //+> PostureEn

      //=========================================================
      int SetPostureEn(const bool PostureEnIn, bool bndchk=true)
      {
         myPostureEn = PostureEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetPostureEn(void) const { return(myPostureEn); }

      //+> Posture

      //=========================================================
      int SetPosture(const PostureGrp PostureIn, bool bndchk=true);

      //=========================================================
      PostureGrp GetPosture(void) const { return(myPosture); }

      //+> WeaponStateEn

      //=========================================================
      int SetWeaponStateEn(const bool WeaponStateEnIn, bool bndchk=true)
      {
         myWeaponStateEn = WeaponStateEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetWeaponStateEn(void) const { return(myWeaponStateEn); }

      //+> WeaponState

      //=========================================================
      int SetWeaponState(const WeaponStateGrp WeaponStateIn, bool bndchk=true);

      //=========================================================
      WeaponStateGrp GetWeaponState(void) const { return(myWeaponState); }

      //+> AnimationStateEn

      //=========================================================
      int SetAnimationStateEn(const bool AnimationStateEnIn, bool bndchk=true)
      {
         myAnimationStateEn = AnimationStateEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetAnimationStateEn(void) const { return(myAnimationStateEn); }

      //+> AnimationState

      //=========================================================
      int SetAnimationState(const AnimationStateGrp AnimationStateIn, bool bndchk=true);

      //=========================================================
      AnimationStateGrp GetAnimationState(void) const { return(myAnimationState); }

      //+> HealthStateEn

      //=========================================================
      int SetHealthStateEn(const bool HealthStateEnIn, bool bndchk=true)
      {
         myHealthStateEn = HealthStateEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetHealthStateEn(void) const { return(myHealthStateEn); }

      //+> HealthState

      //=========================================================
      int SetHealthState(const HealthStateGrp HealthStateIn, bool bndchk=true);

      //=========================================================
      HealthStateGrp GetHealthState(void) const { return(myHealthState); }

      //+> AnimationSpeedEn

      //=========================================================
      int SetAnimationSpeedEn(const bool AnimationSpeedEnIn, bool bndchk=true)
      {
         myAnimationSpeedEn = AnimationSpeedEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetAnimationSpeedEn(void) const { return(myAnimationSpeedEn); }

      //+> Animation Speed

      //=========================================================
      int SetAnimationSpeed(const double AnimationSpeedIn, bool bndchk=true);

      //=========================================================
      double GetAnimationSpeed(void) const { return(myAnimationSpeed); }

      //+> ScaleEn

      //=========================================================
      int SetScaleEn(const bool ScaleEnIn, bool bndchk=true)
      {
         myScaleEn = ScaleEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetScaleEn(void) const { return(myScaleEn); }

      //+> Scale

      //=========================================================
      int SetScale(float XScaleIn, float YScaleIn, float ZScaleIn, bool bndchk=true);

      //=========================================================
      void GetScale(float& XScaleOut, float& YScaleOut, float& ZScaleOut ) const;

      //+> WeightEn

      //=========================================================
      int SetWeightEn(const bool WeightEnIn, bool bndchk=true)
      {
         myWeightEn = WeightEnIn;
         return(CIGI_SUCCESS);
      }

      //=========================================================
      bool GetWeightEn(void) const { return(myWeightEn); }

      //+> Weight

      //=========================================================
      int SetWeight(const float WeightIn, bool bndchk=true);

      //=========================================================
      float GetWeight(void) const { return(myWeight); }

      //+> Animation

      int SetAnimation(const std::string &AnimationIn, bool bndchk=true);

      int GetAnimationSize(void) const { return(myAnimationSize); }

      //=========================================================
      const std::string & GetAnimation(void) const { return(myAnimation); }

      //+> Head Appearance

      int SetHeadAppearance(const std::string &HeadAppearanceIn, bool bndchk=true);

      int GetHeadAppearanceSize(void) const { return(myHeadAppearanceSize); }

      //=========================================================
      const std::string & GetHeadAppearance(void) const { return(myHeadAppearance); }

      //+> Item Appearance

      int SetItemAppearance(const std::string &ItemAppearanceIn, bool bndchk=true);

      int GetItemAppearanceSize(void) const { return(myItemAppearanceSize); }

      //=========================================================
      const std::string & GetItemAppearance(void) const { return(myItemAppearance); }

   protected:
      static int CalculatePaddedStringSize( int StringSizeIn );
      static void BufferToString( PackPointer& CDta, std::string& StringOut );


   protected:

      Cigi_uint16 myEntityID;
      PostureGrp myPosture;
      WeaponStateGrp myWeaponState;
      int myAnimationSize;      // This is the string size padded to a multiple of 8
      std::string myAnimation;
      int myHeadAppearanceSize; // This is the string size padded to a multiple of 8
      std::string myHeadAppearance;
      int myItemAppearanceSize; // This is the string size padded to a multiple of 8
      std::string myItemAppearance;
      double myAnimationSpeed;
      AnimationStateGrp myAnimationState;
      HealthStateGrp myHealthState;
      float myXScale;
      float myYScale;
      float myZScale;
      float myWeight;

      bool myPostureEn;
      bool myWeaponStateEn;
      bool myAnimationStateEn;
      bool myAnimationSpeedEn;
      bool myHealthStateEn;
      bool myScaleEn;
      bool myWeightEn;

      //=========================================================

      static const int MaxStringCharCnt = 71;  
   };
}