VR-Engage  2.2
Loading...
Searching...
No Matches
fireInput.h
Go to the documentation of this file.
1/*********************************************************************************
2** Copyright (c) 2025 MAK Technologies, Inc.
3** All rights reserved.
4*********************************************************************************/
5
6/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7!!!!!!!!!This is an auto-generated file. Any changes will be destroyed!!!!!!!!!!!
8!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
9Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/framework/vreMessages/fireInput.lua
10*/
11/*-----------------COMMENT----------------------
12Send to cause the ownship entity to fire its weapon.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <vlpi/entityIdentifier.h>
20#include <string>
21#include <vlpi/entityType.h>
22#include <matrix/vlVector.h>
23#include <matrix/vlTaitBryan.h>
24
25
26namespace makVre
27{
28
29
30constexpr const char* FireInputMessageType = "system.input.fireInput";
31
33{
34public:
35
36
37 // Struct for defining data
39 {
41
42 DtEntityIdentifier myEntityId;
43 std::string myWeaponGroup;
44 DtEntityType myMunitionType;
46 DtTaitBryan myWorldOrientation;
49
50 bool operator==(const FireInputData& rhs) const;
51 };
52
53 // Default static creators to promote the usage of not using new.
57
58 //! \brief static message identity functions
59 static const std::string& theType();
62
63 //! \brief Get the name of the message type
64 virtual const std::string& type() const override;
65 virtual const makVre::DtVreMessageId& messageId() const override;
66
67 // default destructor
68 virtual ~FireInputMessage() override;
69
70 virtual const DtEntityIdentifier& getEntityId() const;
71 virtual void setEntityId(const DtEntityIdentifier& val);
72
73 virtual const std::string& getWeaponGroup() const;
74 virtual void setWeaponGroup(const std::string& val);
75
76 virtual const DtEntityType& getMunitionType() const;
77 virtual void setMunitionType(const DtEntityType& val);
78
79 virtual const DtVector& getWorldPosition() const;
80 virtual void setWorldPosition(const DtVector& val);
81
82 virtual const DtTaitBryan& getWorldOrientation() const;
83 virtual void setWorldOrientation(const DtTaitBryan& val);
84
85 virtual bool getIsFiring() const;
86 virtual void setIsFiring(bool val);
87
88 virtual bool getIsOverride() const;
89 virtual void setIsOverride(bool val);
90
91
92 // Accessors
93 virtual int messageSize() const override;
94 static makVre::DtVreMessage* decode(char* buffer, int length);
97
98 // Operators
99 bool operator==(const FireInputMessage& rhs) const;
100
101protected:
102 // Inaccessible default constructor to promote the usage of the static creator functions
104
105 virtual void serialize(DtStreamWriter& writer) const override;
106 virtual void deserialize(DtStreamReader& reader) override;
107
108protected:
111
112 // Store the data for future use
114};
115
116} // ::makVre
117
118
119
Reader class for decoding values from a byte array.
Definition byteStream.h:42
Writer class for encoding values into a byte array.
Definition byteStream.h:161
Abstract base class for all VREngage messages.
Definition vreMessage.h:50
Message identifier class for the VREngage messaging system.
Definition vreMessageId.h:35
virtual void setMunitionType(const DtEntityType &val)
static const makVre::DtVreMessageId & theId()
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual void setWorldOrientation(const DtTaitBryan &val)
virtual const DtEntityIdentifier & getEntityId() const
virtual ~FireInputMessage() override
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void setIsOverride(bool val)
static makVre::DtVreMessage * decode(char *buffer, int length)
FireInputData getData()
FireInputData myData
Definition fireInput.h:113
virtual void setWorldPosition(const DtVector &val)
virtual void setIsFiring(bool val)
virtual bool getIsOverride() const
virtual const DtEntityType & getMunitionType() const
static const std::string & theType()
static message identity functions
virtual bool getIsFiring() const
static UInt64 theVersionNumber()
static FireInputMessage * createFrom(FireInputMessage *)
static UInt64 theVersion
Definition fireInput.h:110
virtual int messageSize() const override
Static decode function pattern for derived classes.
bool operator==(const FireInputMessage &rhs) const
virtual const DtTaitBryan & getWorldOrientation() const
virtual void setEntityId(const DtEntityIdentifier &val)
static makVre::DtVreMessageId theMessageId
Definition fireInput.h:109
virtual void setWeaponGroup(const std::string &val)
static FireInputMessage * create()
virtual const std::string & type() const override
Get the name of the message type.
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static FireInputMessage * createFromData(const FireInputData)
FireInputData getData() const
virtual const DtVector & getWorldPosition() const
virtual const std::string & getWeaponGroup() const
Defines export macros for the VREngage Messages library.
#define VREMESSAGES_DLL
Export/import macro for non-Windows platforms.
Definition export.h:39
Include export definitions for this library.
Definition glsVreMessageUtil.h:49
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
constexpr const char * FireInputMessageType
Definition fireInput.h:30
bool myIsOverride
Definition fireInput.h:48
bool myIsFiring
Definition fireInput.h:47
std::string myWeaponGroup
Definition fireInput.h:43
DtVector myWorldPosition
Definition fireInput.h:45
bool operator==(const FireInputData &rhs) const
DtEntityIdentifier myEntityId
Definition fireInput.h:42
DtEntityType myMunitionType
Definition fireInput.h:44
DtTaitBryan myWorldOrientation
Definition fireInput.h:46
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.