VR-Engage  2.2
Loading...
Searching...
No Matches
setEntityVisiblity.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/util.lua
10*/
11/*-----------------COMMENT----------------------
12Send to set visibility for the specified entity. Used to hide the 3rd person model when in first person human view.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19
20
21namespace makVre
22{
23
24
25constexpr const char* SetEntityVisiblityMessageType = "util.setEntityVisiblity";
26
28{
29public:
30
31
32 // Struct for defining data
34 {
36
37 unsigned long long myElementId;
39
40 bool operator==(const SetEntityVisiblityData& rhs) const;
41 };
42
43 // Default static creators to promote the usage of not using new.
47
48 //! \brief static message identity functions
49 static const std::string& theType();
52
53 //! \brief Get the name of the message type
54 virtual const std::string& type() const override;
55 virtual const makVre::DtVreMessageId& messageId() const override;
56
57 // default destructor
58 virtual ~SetEntityVisiblityMessage() override;
59
60 virtual unsigned long long getElementId() const;
61 virtual void setElementId(unsigned long long val);
62
63 virtual bool getVisible() const;
64 virtual void setVisible(bool val);
65
66
67 // Accessors
68 virtual int messageSize() const override;
69 static makVre::DtVreMessage* decode(char* buffer, int length);
72
73 // Operators
74 bool operator==(const SetEntityVisiblityMessage& rhs) const;
75
76protected:
77 // Inaccessible default constructor to promote the usage of the static creator functions
79
80 virtual void serialize(DtStreamWriter& writer) const override;
81 virtual void deserialize(DtStreamReader& reader) override;
82
83protected:
86
87 // Store the data for future use
89};
90
91} // ::makVre
92
93
94
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 setElementId(unsigned long long val)
SetEntityVisiblityData getData()
virtual unsigned long long getElementId() const
virtual ~SetEntityVisiblityMessage() override
static SetEntityVisiblityMessage * create()
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
static UInt64 theVersion
Definition setEntityVisiblity.h:85
static SetEntityVisiblityMessage * createFrom(SetEntityVisiblityMessage *)
static const std::string & theType()
static message identity functions
static makVre::DtVreMessageId theMessageId
Definition setEntityVisiblity.h:84
virtual const std::string & type() const override
Get the name of the message type.
static makVre::DtVreMessage * decode(char *buffer, int length)
static SetEntityVisiblityMessage * createFromData(const SetEntityVisiblityData)
SetEntityVisiblityData myData
Definition setEntityVisiblity.h:88
virtual bool getVisible() const
virtual void setVisible(bool val)
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual int messageSize() const override
Static decode function pattern for derived classes.
bool operator==(const SetEntityVisiblityMessage &rhs) const
SetEntityVisiblityData getData() const
static const makVre::DtVreMessageId & theId()
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 * SetEntityVisiblityMessageType
Definition setEntityVisiblity.h:25
unsigned long long myElementId
Definition setEntityVisiblity.h:37
bool operator==(const SetEntityVisiblityData &rhs) const
bool myVisible
Definition setEntityVisiblity.h:38
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.