simulationState.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/
 
/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!This is an auto-generated file.  Any changes will be destroyed!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/entity.lua
*/
/*-----------------COMMENT----------------------
State update for an entity. Sent any time there's a network update for an entity.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <vlpi/entityType.h>
#include <string>
#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* SimulationStateMessageType = "simulation.state.entity";
 
class VREMESSAGES_DLL SimulationStateMessage : public makVre::DtVreMessage
{
public:
   enum TrailingEffects {TrailingEffects_NONE, TrailingEffects_SMALL, TrailingEffects_MEDIUM, TrailingEffects_LARGE};
   enum ForceType {ForceType_OTHER, ForceType_FRIENDLY, ForceType_OPPOSING, ForceType_NEUTRAL};
   enum ParameterTypes {ParameterTypes_POSITION= 1, ParameterTypes_POSITIONRATE= 2, ParameterTypes_EXTENSION= 3, ParameterTypes_EXTENSIONRATE = 4, ParameterTypes_X= 5, ParameterTypes_XRATE= 6, ParameterTypes_Y= 7, ParameterTypes_YRATE= 8, ParameterTypes_Z= 9, ParameterTypes_ZRATE= 10, ParameterTypes_AZIMUTH= 11, ParameterTypes_AZIMUTHRATE= 12, ParameterTypes_ELEVATION= 13, ParameterTypes_ELEVATIONRATE = 14, ParameterTypes_ROTATION= 15, ParameterTypes_ROTATIONRATE= 16};
   enum WeaponState {WeaponState_NOWEAPON, WeaponState_STOWED, WeaponState_DEPLOYED, WeaponState_FIREPOSITION};
   enum EmbeddedEntityState {EmbeddedEntityState_RECOVERED, EmbeddedEntityState_DEPLOYED_AND_EXTANT, EmbeddedEntityState_DEPLOYED_AND_DELETED, EmbeddedEntityState_UNKNOWN};
   enum ComplianceState {ComplianceState_NA, ComplianceState_DETAINED, ComplianceState_SURRENDER, ComplianceState_USING_FISTS, ComplianceState_VERBAL_ABUSE1, ComplianceState_VERBAL_ABUSE2, ComplianceState_VERBAL_ABUSE3, ComplianceState_PASSIVE_RESISTANCE1, ComplianceState_PASSIVE_RESISTANCE2, ComplianceState_PASSIVE_RESISTANCE3, ComplianceState_NON_LETHAL_WEAPON1, ComplianceState_NON_LETHAL_WEAPON2, ComplianceState_NON_LETHAL_WEAPON3, ComplianceState_NON_LETHAL_WEAPON4, ComplianceState_NON_LETHAL_WEAPON5, ComplianceState_NON_LETHAL_WEAPON6};
   enum LightType {LightType_LIGHTS=12, LightType_HEAD_LIGHTS=12, LightType_FLASH_LIGHTS=12, LightType_LANDING_LIGHTS=12, LightType_RUNNING_LIGHTS=12, LightType_TAIL_LIGHTS=13, LightType_NAVIGATION_LIGHTS=13, LightType_ANTI_COLLISION_LIGHTS=14, LightType_BRAKE_LIGHTS=14, LightType_FORMATION_LIGHTS=24, LightType_BLACK_OUT_LIGHTS=26, LightType_BLACK_OUT_BRAKE_LIGHTS=27, LightType_SPOT_LIGHTS=28, LightType_EXTERIOR_LIGHTS=28, LightType_EXTERNAL_LIGHTS=28, LightType_INTERIOR_LIGHTS=29, LightType_INTERNAL_LIGHTS=29};
   enum DamageState {DamageState_NONE, DamageState_SLIGHT, DamageState_MODERATE, DamageState_DESTROYED};
   enum LifeformState {LifeformState_NA, LifeformState_STANDING, LifeformState_WALKING, LifeformState_RUNNING, LifeformState_KNEELING, LifeformState_PRONE, LifeformState_CRAWLING, LifeformState_SWIMMING, LifeformState_PARACHUTING, LifeformState_JUMPING, LifeformState_SITTING, LifeformState_SQUATTING, LifeformState_CROUCHING, LifeformState_WADING, LifeformState_SURRENDERED, LifeformState_DETAINED};
   enum HatchState {HatchState_NA, HatchState_CLOSED, HatchState_POPPED, HatchState_POPPEDANDPERSON, HatchState_OPEN, HatchState_OPENANDPERSON};
   enum CamoflageType {CamoflageType_DESERT, CamoflageType_WINTER, CamoflageType_FOREST};
 
   struct VREMESSAGES_DLL EmbeddedEntity
   {
      EmbeddedEntity();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const EmbeddedEntity& rhs) const;
      
      std::string myName;
      DtEntityType myType;
      EmbeddedEntityState myState;
      DtEntityIdentifier myEntityId;
      int myDeployTime;
 
   };
 
   struct VREMESSAGES_DLL EngagedRole
   {
      EngagedRole();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const EngagedRole& rhs) const;
      
      std::string myRole;
      std::string myStationIds;
 
   };
 
   struct VREMESSAGES_DLL AttPart
   {
      AttPart();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const AttPart& rhs) const;
      
      DtEntityType myType;
      int myStationId;
 
   };
 
   struct VREMESSAGES_DLL Parameter
   {
      Parameter();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const Parameter& rhs) const;
      
      float myValue;
      ParameterTypes myParameter;
 
   };
 
   struct VREMESSAGES_DLL ArtPart
   {
      ArtPart();
 
      int size() const;
      void serialize(DtStreamWriter& writer) const;
      void deserialize(DtStreamReader& reader);
      bool operator==(const ArtPart& rhs) const;
      
      int myId;
      int myAttachedTo;
      DtVector myTranslation;
      DtVector myTranslationRate;
      DtTaitBryan myOrientation;
      DtVector myRotationalVelocity;
      std::vector<Parameter> myParameters;
 
   };
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL SimulationStateData 
   {
      SimulationStateData();
 
      DtEntityIdentifier myId;
      DtEntityType myType;
      std::string myObjectLabel;
      DamageState myDamageState;
      DtVector myWorldPosition;
      DtVector32 myWorldVelocity;
      DtVector32 myWorldAcceleration;
      DtTaitBryan myWorldOrientation;
      DtVector32 myRotationalVelocity;
      ForceType myForceType;
      unsigned int myAppearanceBits;
      std::vector<ArtPart> myArticulatedParts;
      DtEntityIdentifier myHost;
      DtEntityType myHostType;
      std::string myHostMarking;
      DtVector32 myRelativeVelocity;
      std::string myAutopilotMode;
      std::string myDiguyType;
      std::string myDiguyAppearance;
      std::string myDiguyItem;
      std::string myDiguyAction;
      int myWeaponIndex;
      int myWeaponState;
      std::string myCameraSystemName;
      std::vector<DtEntityIdentifier> myCameraObjectNames;
      std::vector<DtEntityIdentifier> myGateObjectNames;
      std::vector<EmbeddedEntity> myEmbeddedEntities;
      int myAltitudeAgl;
      std::vector<std::string> myDisabledInstruments;
      std::vector<float> myPidGains;
      bool myHideOccupants;
      std::string myEmbarkedAsRole;
      bool myInvisible;
      std::vector<EngagedRole> myEngagedRoles;
 
      bool operator==(const SimulationStateData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static SimulationStateMessage* create();
   static SimulationStateMessage* createFrom(SimulationStateMessage*);
   static SimulationStateMessage* createFromData(const SimulationStateData);
   
   //! \brief static message identity functions
   static const std::string& theType();
   static const makVre::DtVreMessageId& theId();
   static UInt64 theVersionNumber();
 
   //! \brief Get the name of the message type
   virtual const std::string& type() const override;
   virtual const makVre::DtVreMessageId& messageId() const override;
 
   // default destructor
   virtual ~SimulationStateMessage() override;
 
   virtual const DtEntityIdentifier& getId() const;
   virtual void setId(const DtEntityIdentifier& val);
 
   virtual const DtEntityType& getType() const;
   virtual void setType(const DtEntityType& val);
 
   virtual const std::string& getObjectLabel() const;
   virtual void setObjectLabel(const std::string& val);
 
   virtual DamageState getDamageState() const;
   virtual void setDamageState(DamageState val);
 
   virtual const DtVector& getWorldPosition() const;
   virtual void setWorldPosition(const DtVector& val);
 
   virtual const DtVector32& getWorldVelocity() const;
   virtual void setWorldVelocity(const DtVector32& val);
 
   virtual const DtVector32& getWorldAcceleration() const;
   virtual void setWorldAcceleration(const DtVector32& val);
 
   virtual const DtTaitBryan& getWorldOrientation() const;
   virtual void setWorldOrientation(const DtTaitBryan& val);
 
   virtual const DtVector32& getRotationalVelocity() const;
   virtual void setRotationalVelocity(const DtVector32& val);
 
   virtual ForceType getForceType() const;
   virtual void setForceType(ForceType val);
 
   virtual unsigned int getAppearanceBits() const;
   virtual void setAppearanceBits(unsigned int val);
 
   virtual const std::vector<ArtPart>& getArticulatedParts() const;
   virtual void setArticulatedParts(const std::vector<ArtPart>& val);
 
   virtual const DtEntityIdentifier& getHost() const;
   virtual void setHost(const DtEntityIdentifier& val);
 
   virtual const DtEntityType& getHostType() const;
   virtual void setHostType(const DtEntityType& val);
 
   virtual const std::string& getHostMarking() const;
   virtual void setHostMarking(const std::string& val);
 
   virtual const DtVector32& getRelativeVelocity() const;
   virtual void setRelativeVelocity(const DtVector32& val);
 
   virtual const std::string& getAutopilotMode() const;
   virtual void setAutopilotMode(const std::string& val);
 
   virtual const std::string& getDiguyType() const;
   virtual void setDiguyType(const std::string& val);
 
   virtual const std::string& getDiguyAppearance() const;
   virtual void setDiguyAppearance(const std::string& val);
 
   virtual const std::string& getDiguyItem() const;
   virtual void setDiguyItem(const std::string& val);
 
   virtual const std::string& getDiguyAction() const;
   virtual void setDiguyAction(const std::string& val);
 
   virtual int getWeaponIndex() const;
   virtual void setWeaponIndex(int val);
 
   virtual int getWeaponState() const;
   virtual void setWeaponState(int val);
 
   virtual const std::string& getCameraSystemName() const;
   virtual void setCameraSystemName(const std::string& val);
 
   virtual const std::vector<DtEntityIdentifier>& getCameraObjectNames() const;
   virtual void setCameraObjectNames(const std::vector<DtEntityIdentifier>& val);
 
   virtual const std::vector<DtEntityIdentifier>& getGateObjectNames() const;
   virtual void setGateObjectNames(const std::vector<DtEntityIdentifier>& val);
 
   virtual const std::vector<EmbeddedEntity>& getEmbeddedEntities() const;
   virtual void setEmbeddedEntities(const std::vector<EmbeddedEntity>& val);
 
   virtual int getAltitudeAgl() const;
   virtual void setAltitudeAgl(int val);
 
   virtual const std::vector<std::string>& getDisabledInstruments() const;
   virtual void setDisabledInstruments(const std::vector<std::string>& val);
 
   virtual const std::vector<float>& getPidGains() const;
   virtual void setPidGains(const std::vector<float>& val);
 
   virtual bool getHideOccupants() const;
   virtual void setHideOccupants(bool val);
 
   virtual const std::string& getEmbarkedAsRole() const;
   virtual void setEmbarkedAsRole(const std::string& val);
 
   virtual bool getInvisible() const;
   virtual void setInvisible(bool val);
 
   virtual const std::vector<EngagedRole>& getEngagedRoles() const;
   virtual void setEngagedRoles(const std::vector<EngagedRole>& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   SimulationStateData getData();
   SimulationStateData getData() const;
 
   // Operators
   bool operator==(const SimulationStateMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   SimulationStateMessage();
 
   virtual void serialize(DtStreamWriter& writer) const override;
   virtual void deserialize(DtStreamReader& reader) override;
 
protected:
   static makVre::DtVreMessageId theMessageId;
   static UInt64 theVersion;
 
   // Store the data for future use
   SimulationStateData myData;
};
 
} // ::makVre