extDiGuyCustomPduDecoder.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2019 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#if DtDIS

#include <vrfExtObjects/dllExport.h>
#include <vl/diGuyCustomPduDecoder.h>

// Because there's a limit to the range of values defined inside VR-Link and we need more
// Must match the following enumerations:
//   - VR-Link: include/vl/diguyCustomPdu.h (DtDIGuyCustomPduMsgId)
//   - DI-Guy:  src/libs/libpeopleshop/src/diguy_dis_constants.h (diguyCustomPDUType)
enum DtExtDIGuyCustomPduMsgId
{
   DtExtDIGuyMsgIdEscapeReserved = 0,
   DtExtDIGuyMsgIdSetCharType = 1,
   DtExtDIGuyMsgIdSetCharAppearance = 2,
   DtExtDIGuyMsgIdSetCharAction = 3,
   DtExtDIGuyMsgIdSetCharVisible = 4,
   DtExtDIGuyMsgIdBeginAppearanceEffect = 34,
   DtExtDIGuyMsgIdEndAppearanceEffect,
   DtExtDIGuyMsgIdStopAppearanceEffect,
   DtExtDIGuyMsgIdExecuteGesture = 41,
   DtExtDIGuyMsgIdCharacterScale,
   DtExtDIGuyMsgIdSetShapeVariation2,
   DtExtDIGuyMsgIdEndGesture
};

// ======================================================================================
// Note: the PDU-decoding code that exists here should be kept in sync with the PDU code
// that lives in bdiDisInterface and bdiExerciseInterfaceDis in DI-Guy.
// ======================================================================================

/*
   This class extends the decoder in VR-Link. It exists only as a home for several
   static encoder functions, which will replace the original ones in the parent class.

   Instructions for developers who come here in the future:

   Go to c:\mak-dev\vrvantage-for-forces\include\vrvVrl\DtEntityExistenceListener.inl
   The code in processDiGuyPdu() must be moved here. Unfortunately, the stuff with
   the listener doesn't translate well -- we'll need to update the DI-Guy ESR to support
   appearance effects, gestures, variations, and so forth.
*/
class DT_DLL_vrfExtObjects DtExtDIGuyCustomPduDecoder : public DtDIGuyCustomPduDecoder
{
public:

   DtExtDIGuyCustomPduDecoder();
   virtual ~DtExtDIGuyCustomPduDecoder();

   virtual void decode( DtPdu* pdu, DtEntityStateRepository* stateRep );
   virtual DtPduDecoder* clone() const;
   virtual void clearCallbacks();

   virtual void addDiGuyPduCallback( DtExtDIGuyCustomPduMsgId k, DtDIGuyPduCallbackFcn info );
   virtual void removeDiGuyPduCallback( DtExtDIGuyCustomPduMsgId k, const DtDIGuyPduCallbackFcn& info );

public:

   static void processDiGuyAppearance( DtDIGuyCustomPdu* pdu, DtEntityStateRepository* pEsr );
   static void processDiGuyType( DtDIGuyCustomPdu* pdu, DtEntityStateRepository* pEsr );
   static void processDiGuyAction( DtDIGuyCustomPdu* pdu, DtEntityStateRepository* pEsr );

protected:

   // We're replacing the array in the parent class because it wasn't big enough.
   // (std::set isn't expandable)
#define DtEXTMAX_DIGUYMSG_KINDS 50
   std::set<DtDIGuyPduCallbackFcn> myExtDiGuyCbList[DtEXTMAX_DIGUYMSG_KINDS];

};

#endif  // DtDIS