extDiGuyCustomPduDecoder.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2021 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


#pragma once

// This class isn't used for anything at the moment, but is being left in makVrfVrlExt in case it
// is needed in the future. The class should only be enabled if something *REALLY* needs to be
// added at the makVrfVrlExt level and should be carefully tracked so it is removed once the
// logic makes it into VR-Link so the stale logic doesn't end up causing bugs in VRV/VRF *AGAIN*.
#define MAKVRFVRLEXT_USE_EXT_DIGUY_CUSTOM_PDU_DECODER_DIS 0
#if MAKVRFVRLEXT_USE_EXT_DIGUY_CUSTOM_PDU_DECODER_DIS

#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
// This enumeration must match the following enumerations:
//   - VR-Link: include/vl/disEnums.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,
   DtExtDIGuyMsgIdMax = 52
};

// Used for allocating space for callback list.
#define DtEXTMAX_DIGUYMSG_KINDS 52

// Adding functionality here only changes the legacy custom PDU behavior. Only add something here if you're
// certain it needs to be added to the legacy custom PDUs. New functionality should be added using extended
// attributes instead.

// ======================================================================================
// Note: The following code is the same logic in DtDIGuyCustomPduDecoder in VR-Link and should be kept in sync.
// If making any changes to this class file a feature in VR-Link so the functionality can be ported over and
// include a note that the logic added here should be removed when the feature is complete so it's not forgotten.
// ======================================================================================

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:

   virtual void processDiGuyNewAttribute( 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).
   std::set<DtDIGuyPduCallbackFcn> myExtDiGuyCbList[DtEXTMAX_DIGUYMSG_KINDS];

};

#endif // DtDIS
#endif // MAKVRFVRLEXT_USE_EXT_DIGUY_CUSTOM_PDU_DECODER_DIS