fire.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/fire.lua
*/
/*-----------------COMMENT----------------------
Sent in the VR-Engage GUI when a fire interaction is received. Propagates the event outside the network thread.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
#include <matrix/vlVector.h>
#include <vlpi/entityType.h>
 
 
namespace makVre
{
 
 
constexpr const char* FireMessageType = "simulation.fire";
 
class VREMESSAGES_DLL FireMessage : public makVre::DtVreMessage
{
public:
   enum FuzeType {FuzeType_OTHER=0, FuzeType_CONTACT=1000, FuzeType_CONTACTINSTANT=1100, FuzeType_CONTACTDELAYED=1200, FuzeType_TIMED=2000, FuzeType_PROXIMITY=3000, FuzeType_COMMAND=4000, FuzeType_ALTITUDE=5000, FuzeType_DEPTH=6000, FuzeType_ACOUSTIC=7000};
   enum WarheadType {WarheadType_OTHER=0, WarheadType_HIGHEXPLOSIVE=1000, WarheadType_HIGHEXPLOSIVEPLATIC=1100, WarheadType_HIGHEXPLOSIVEINCENDIARY=1200, WarheadType_HIGHEXPLOSIVEFRAGMENTATION=1300, WarheadType_HIGHEXPLOSIVEANTITANK=1400, WarheadType_HIGHEXPLOSIVEBOMBLETS=1500, WarheadType_HIGHEXPLOSIVESHAPEDCHARGE=1600, WarheadType_SMOKE=2000, WarheadType_ILLUMINATION=3000, WarheadType_PRACTICE=4000, WarheadType_KINETIC=5000, WarheadType_UNUSED=6000, WarheadType_NUCLEAR=7000, WarheadType_CHEMICALGENERAL=8000, WarheadType_CHEMICALBLISTER=8100, WarheadType_CHEMICALBLOOD=8200, WarheadType_CHEMICALNERVE=8300, WarheadType_BIOLOGICALGENERAL=9000};
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL FireData 
   {
      FireData();
 
      std::string myFiringId;
      std::string myTargetId;
      std::string myMunitionId;
      DtVector myWorldPosition;
      DtVector myVelocity;
      double myRange;
      int myEventId;
      DtEntityType myMunitionType;
      FuzeType myFuzeType;
      WarheadType myWarheadType;
      int myQuantity;
      int myRate;
 
      bool operator==(const FireData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static FireMessage* create();
   static FireMessage* createFrom(FireMessage*);
   static FireMessage* createFromData(const FireData);
   
   //! \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 ~FireMessage() override;
 
   virtual const std::string& getFiringId() const;
   virtual void setFiringId(const std::string& val);
 
   virtual const std::string& getTargetId() const;
   virtual void setTargetId(const std::string& val);
 
   virtual const std::string& getMunitionId() const;
   virtual void setMunitionId(const std::string& val);
 
   virtual const DtVector& getWorldPosition() const;
   virtual void setWorldPosition(const DtVector& val);
 
   virtual const DtVector& getVelocity() const;
   virtual void setVelocity(const DtVector& val);
 
   virtual double getRange() const;
   virtual void setRange(double val);
 
   virtual int getEventId() const;
   virtual void setEventId(int val);
 
   virtual const DtEntityType& getMunitionType() const;
   virtual void setMunitionType(const DtEntityType& val);
 
   virtual FuzeType getFuzeType() const;
   virtual void setFuzeType(FuzeType val);
 
   virtual WarheadType getWarheadType() const;
   virtual void setWarheadType(WarheadType val);
 
   virtual int getQuantity() const;
   virtual void setQuantity(int val);
 
   virtual int getRate() const;
   virtual void setRate(int val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   FireData getData();
   FireData getData() const;
 
   // Operators
   bool operator==(const FireMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   FireMessage();
 
   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
   FireData myData;
};
 
} // ::makVre