orbatStateComponent.h

Go to the documentation of this file.

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

#pragma once

#include "vrfStateData/stateComponent.h"
#include "vrfStateData/simulatedObjectStateComponent.h"
#include "vrfStateData/doubleBufferedDataStorage.h"
#include <vrfutil/rwOrbatData.h>

namespace makVrf
{

   struct DT_DLL_vrfStateData DtOrbatStateComponentData
   {
      DtOrbatStateComponentData()
      : myUUID(DtUUID::nullUUID())
      {
      }

      DtOrbatStateComponentData(const DtOrbatStateComponentData& orig)
      {
         *this = orig;
      };

      DtOrbatStateComponentData& operator=(const DtOrbatStateComponentData& orig)
      {
         myData = orig.myData;
         myUUID = orig.myUUID;
         myUserData = orig.myUserData;
         myObjectId = orig.myObjectId;

         return *this;
      };

      const DtRwOrbatData& data() const
      {
         return myData;
      }

      DtRwOrbatData& data()
      {
         return myData;
      }

      DEFINE_ACCESSOR_MUTATOR(DtUUID, uuid, UUID)
      DEFINE_ACCESSOR_MUTATOR(DtEntityIdentifier, entityId, EntityId)
      DEFINE_ACCESSOR_MUTATOR(unsigned long long, userData, UserData)
      DEFINE_ACCESSOR_MUTATOR(unsigned long long, objectId, ObjectId)

   protected:
      DtUUID myUUID;
      DtEntityIdentifier myEntityId;
      DtRwOrbatData myData;
      unsigned long long myUserData = 0;
      unsigned long long myObjectId = 0;
   };

   class DT_DLL_vrfStateData DtOrbatStateComponent : public DtSimulatedObjectStateComponent
   {
   public:
      DEFINE_STATE_COMPONENT_TYPE(DtStateComponent::OrbatStateComponent)

      DtOrbatStateComponent(DtStateData* storage)
      : DtSimulatedObjectStateComponent(storage)
      {
      }

      UNDEFINED_RETURNREF_ACCESSOR(DtUUID, orbatUUID);
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(int, orbatOrder, OrbatOrder);
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtUUID, parent, Parent);
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtRwOrbatData, data, Data);
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(unsigned long long, objectId, ObjectId);
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtString, label, Label);

      virtual bool mainComponentOnLegion() const override { return false; };
   };

   class DT_DLL_vrfStateData DtOrbatStateComponentNextFrame : public DtOrbatStateComponent
   {
   public:
      DtOrbatStateComponentNextFrame(DtStateData* storage);

      virtual const DtUUID& orbatUUID() const override;

      virtual const int orbatOrder() const override;
      virtual void setOrbatOrder(const int&) override;

      virtual const unsigned long long& objectId() const override;
      virtual void setObjectId(const unsigned long long&) override;

      virtual const DtRwOrbatData& data() const override;
      virtual void setData(const DtRwOrbatData&) override;

      virtual const DtUUID& parent() const override;
      virtual void setParent(const DtUUID&) override;


      DtOrbatStateComponentData& frameState() { return myData; };
      const DtOrbatStateComponentData& frameState() const { return myData; };

      virtual const bool& isLocal() const override;
      virtual void setIsLocal(const bool&) override;
   
      virtual const bool& checkForNameReservation() const override;
      virtual void setCheckForNameReservation(const bool&) override;

      virtual const DtEntityIdentifier& entityId() const override;
      virtual void setEntityId(const DtEntityIdentifier&) override;

      virtual const DtString& globalId() const override;
      virtual void setGlobalId(const DtString&) override;

      virtual const UInt32 appearanceBits() const override;

      virtual const DtString& label() const override;
      virtual void setLabel(const DtString&) override;

      virtual const DtUUID& uuid() const override;
      virtual void setUUID(const DtUUID& u) override;

      virtual const DtString& markingText() const override;
      virtual void setMarkingText(const DtString&) override;

      virtual const DtForceType forceType() const override;
      virtual void setForceType(const DtForceType&) override;

      virtual const DtEntityType entityType() const override { return objectType(); };
      virtual const DtEntityType objectType() const override;
      virtual void setEntityType(const DtEntityType& t) override;
      virtual const DtSimulationAddress simEngineAddress() const override;

      virtual const unsigned long long userLongLongData() const override;
      virtual void setUserLongLongData(const unsigned long long&) override;

      virtual void makeWritable() override;

      virtual void makeReadOnly() override;

   protected:
      DtOrbatStateComponentData myData;
   };

   class DT_DLL_vrfStateData DtOrbatStateComponentCurrentFrame : public DtOrbatStateComponent
   {
   public:
      DtOrbatStateComponentCurrentFrame(DtStateData* storage);

      virtual const UInt32 appearanceBits() const override;
      virtual const unsigned long long& objectId() const override;
      virtual const bool& checkForNameReservation() const override;
      virtual const bool& isLocal() const override;
      virtual const DtUUID& orbatUUID() const override;
      virtual const int orbatOrder() const override;
      virtual const DtString& label() const override;
      virtual const DtUUID& parent() const override;
      virtual const DtEntityIdentifier& entityId() const override;
      virtual const DtString& globalId() const override;
      virtual const DtUUID& uuid() const override;
      virtual const DtString& markingText() const override;
      virtual const DtForceType forceType() const override;
      virtual const DtEntityType entityType() const override { return objectType(); };
      virtual const DtEntityType objectType() const override;
      virtual const unsigned long long userLongLongData() const override;
      virtual const DtSimulationAddress simEngineAddress() const override;

      virtual const DtRwOrbatData& data() const override;
      const DtOrbatStateComponentData& frameState() const { return myData; };

   protected:
      friend class DtOrbatStateComponentImplementation;
      void advanceFrame(const DtOrbatStateComponentData& data)
      {
         myData = data;
      }

   protected:
      DtOrbatStateComponentData myData;
   };

   class DT_DLL_vrfStateData DtOrbatStateComponentImplementation : public DtDoubleBufferedStateComponent<DtOrbatStateComponent>
   {
   public:
      DtOrbatStateComponentImplementation(DtStateData* sd);
      virtual ~DtOrbatStateComponentImplementation() override;

      bool isDoubleBuffered() { return true; };
      virtual const DtFrameStateInterface* currentFrameState() const override { return &myCurrentFrameState; }
      virtual DtFrameStateInterface* nextFrameState() override { return &myNextFrameState; };
      virtual const DtFrameStateInterface* nextFrameState() const override { return &myNextFrameState; };

      virtual void updateDataStorage() override
      {
         if (myNextFrameState.isWritable())
         {
            myCurrentFrameState.advanceFrame(myNextFrameState.frameState());
         }

         myCurrentFrameState.emitComponentUpdated();
      }

      virtual void updateStateData(DtStateData* sd) override
      {
         myCurrentFrameState.updateStateData(sd);
         myNextFrameState.updateStateData(sd);
      }

      virtual void aboutToBeDeleted() override
      {
         DtDoubleBufferedStateComponent<DtOrbatStateComponent>::aboutToBeDeleted();
         myCurrentFrameState.aboutToBeDeleted();
         myNextFrameState.aboutToBeDeleted();
      }

      virtual void convertToLocal() override;
      virtual void convertToRemote() override;

   protected:
      DtOrbatStateComponentCurrentFrame myCurrentFrameState;
      DtOrbatStateComponentNextFrame myNextFrameState;
   };

   typedef DtStateComponentCreator<DtOrbatStateComponentImplementation> DtOrbatStateComponentCreator;
}