VR-Engage  2.2
Loading...
Searching...
No Matches
vrfSetLookAtPoint.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/vrfEntitySetDataRequests.lua
10*/
11/*-----------------COMMENT----------------------
12Send to the DtVrfRemoteControlConnector to generate a VRF set look at point request.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <vlpi/entityIdentifier.h>
20#include <matrix/vlVector.h>
21
22
23namespace makVre
24{
25
26
27constexpr const char* VrfSetLookAtPointMessageType = "vrf.set.lookatpoint";
28
30{
31public:
33
34
35 // Struct for defining data
37 {
39
40 DtEntityIdentifier myEntityId;
42 DtVector myAimingPoint;
43 DtEntityIdentifier myTarget;
44 double myAzimuth;
46
47 bool operator==(const VrfSetLookAtPointData& rhs) const;
48 };
49
50 // Default static creators to promote the usage of not using new.
54
55 //! \brief static message identity functions
56 static const std::string& theType();
59
60 //! \brief Get the name of the message type
61 virtual const std::string& type() const override;
62 virtual const makVre::DtVreMessageId& messageId() const override;
63
64 // default destructor
65 virtual ~VrfSetLookAtPointMessage() override;
66
67 virtual const DtEntityIdentifier& getEntityId() const;
68 virtual void setEntityId(const DtEntityIdentifier& val);
69
70 virtual LookAtType getLookAtType() const;
71 virtual void setLookAtType(LookAtType val);
72
73 virtual const DtVector& getAimingPoint() const;
74 virtual void setAimingPoint(const DtVector& val);
75
76 virtual const DtEntityIdentifier& getTarget() const;
77 virtual void setTarget(const DtEntityIdentifier& val);
78
79 virtual double getAzimuth() const;
80 virtual void setAzimuth(double val);
81
82 virtual double getElevation() const;
83 virtual void setElevation(double val);
84
85
86 // Accessors
87 virtual int messageSize() const override;
88 static makVre::DtVreMessage* decode(char* buffer, int length);
91
92 // Operators
93 bool operator==(const VrfSetLookAtPointMessage& rhs) const;
94
95protected:
96 // Inaccessible default constructor to promote the usage of the static creator functions
98
99 virtual void serialize(DtStreamWriter& writer) const override;
100 virtual void deserialize(DtStreamReader& reader) override;
101
102protected:
105
106 // Store the data for future use
108};
109
110} // ::makVre
111
112
113
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 const DtEntityIdentifier & getTarget() const
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static makVre::DtVreMessageId theMessageId
Definition vrfSetLookAtPoint.h:103
virtual ~VrfSetLookAtPointMessage() override
static VrfSetLookAtPointMessage * createFromData(const VrfSetLookAtPointData)
VrfSetLookAtPointData getData() const
VrfSetLookAtPointData getData()
static makVre::DtVreMessage * decode(char *buffer, int length)
static VrfSetLookAtPointMessage * create()
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void setAzimuth(double val)
static const makVre::DtVreMessageId & theId()
static UInt64 theVersion
Definition vrfSetLookAtPoint.h:104
virtual const DtEntityIdentifier & getEntityId() const
static const std::string & theType()
static message identity functions
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual const DtVector & getAimingPoint() const
static VrfSetLookAtPointMessage * createFrom(VrfSetLookAtPointMessage *)
VrfSetLookAtPointData myData
Definition vrfSetLookAtPoint.h:107
LookAtType
Definition vrfSetLookAtPoint.h:32
@ LookAtType_POINT
Definition vrfSetLookAtPoint.h:32
@ LookAtType_OBJECT
Definition vrfSetLookAtPoint.h:32
@ LookAtType_ANGLE
Definition vrfSetLookAtPoint.h:32
@ LookAtType_CEASE_LOOKING
Definition vrfSetLookAtPoint.h:32
virtual void setTarget(const DtEntityIdentifier &val)
virtual LookAtType getLookAtType() const
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
bool operator==(const VrfSetLookAtPointMessage &rhs) const
virtual double getElevation() const
virtual void setElevation(double val)
virtual void setAimingPoint(const DtVector &val)
virtual void setEntityId(const DtEntityIdentifier &val)
virtual double getAzimuth() const
virtual void setLookAtType(LookAtType val)
virtual const std::string & type() const override
Get the name of the message type.
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 * VrfSetLookAtPointMessageType
Definition vrfSetLookAtPoint.h:27
DtEntityIdentifier myEntityId
Definition vrfSetLookAtPoint.h:40
bool operator==(const VrfSetLookAtPointData &rhs) const
LookAtType myLookAtType
Definition vrfSetLookAtPoint.h:41
double myElevation
Definition vrfSetLookAtPoint.h:45
DtEntityIdentifier myTarget
Definition vrfSetLookAtPoint.h:43
DtVector myAimingPoint
Definition vrfSetLookAtPoint.h:42
double myAzimuth
Definition vrfSetLookAtPoint.h:44
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.