pVrfScriptedTask.h

Go to the documentation of this file.

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


#pragma once

#include <portal/dllExport.h>
#include <portal/pInteraction.h>

namespace MAKVrExchange
{

   class DtPortalConnection;

   class DT_DLL_LIBPORTAL DtPortalVrfScriptedTaskInteraction
      : public DtPortalInteraction
   {
   public:

      enum ScriptedTaskVariableType
      {
         Unknown                   = 0,
         AggregateFormation        = 1,
         AltitudeMSL               = 2,
         BombResource              = 3,
         Boolean                   = 4,
         ChoiceDropDownList        = 5,
         ChoiceOptionButton        = 6,
         DIGuyAnimation            = 7,
         DIGuyAppearance           = 8,
         Distance                  = 9,
         Emitter                   = 10,
         EntityType                = 11,
         Force                     = 12,
         Heading                   = 13,
         Integer                   = 14,
         LocationWithAltitude      = 15,
         LocationWithoutAltitude   = 16,
         MunitionResource          = 17,
         OffsetLocation            = 18,
         Real                      = 19,
         Resource                  = 20,
         SimulationObjectSingle    = 21,
         SimulationObjectMultiple  = 22,
         Speed                     = 23,
         String                    = 24,
         Time                      = 25,
         TurnRate                  = 26,
         DepthMSL                  = 27
      };

      // structure of data values in the avpl
      struct MsgHeader {
         DtU32 type;
      };

      struct MsgInt {
         MsgHeader header;
         int value;
      };

      struct MsgDouble {
         MsgHeader header;
         double value;
      };

      struct MsgString {
         MsgHeader header;
         int len;
      };

      struct MsgVector {
         MsgHeader header;
         DtVector value;
      };

   public:

      typedef void (*functionCallback_type) (
         const DtPortalVrfScriptedTaskInteraction& interaction, void* userData );

      DtPortalVrfScriptedTaskInteraction();

      virtual ~DtPortalVrfScriptedTaskInteraction();

      static void addCallback( DtPortalConnection* connection,
         functionCallback_type callbackFunction, void* userData );

      static void removeCallback( DtPortalConnection* connection,
         functionCallback_type callbackFunction, void* userData );


      DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
      DtDEC_ATTRIBUTE( DtString, ReceivingEntity, receivingEntity );
      DtDEC_ATTRIBUTE( DtString, ScriptID, scriptID );
      DtDEC_ATTRIBUTE( bool, Subtask, subtask);
      DtDEC_ATTRIBUTE( DtAttributeValuePairList, VariableDatumSet, variableDatumSet );


   public:

      static const DtPortalMessageKind theKind;

      static DtPortalMessage* create();

      virtual unsigned int netSize() const;
      virtual void writeSelfToBuffer( void* buffer, int bufferSize ) const;
      virtual void readSelfFromBuffer( const void* buffer, int bufferSize );

      virtual std::ostream& printDataToStream( std::ostream& stream ) const;

   private:

      DtPortalVrfScriptedTaskInteraction& operator = (
         const DtPortalVrfScriptedTaskInteraction& );

      bool operator == ( const DtPortalVrfScriptedTaskInteraction& ) const;

      bool operator != ( const DtPortalVrfScriptedTaskInteraction& ) const;

   };


   inline DtPortalMessage* DtPortalVrfScriptedTaskInteraction::create()
   {
      return new DtPortalVrfScriptedTaskInteraction();
   }

}