VR-Engage  2.2
Loading...
Searching...
No Matches
addChannelEventProcessorAssociation.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/windowOperations.lua
10*/
11/*-----------------COMMENT----------------------
12Used to redirect one channel's event processor actions to another. Used on minimap creation to enable events (mouse movements, for example) that occur on one channel to be processed by another channel.
13-------------------COMMENT----------------------*/
14#pragma once
15
18#include <vreMessages/export.h>
19#include <string>
20
21
22namespace makVre
23{
24
25
26constexpr const char* AddChannelEventProcessorAssociationMessageType = "channel.addChannelEventProcessorAssociation";
27
29{
30public:
31
32
33 // Struct for defining data
45
46 // Default static creators to promote the usage of not using new.
50
51 //! \brief static message identity functions
52 static const std::string& theType();
55
56 //! \brief Get the name of the message type
57 virtual const std::string& type() const override;
58 virtual const makVre::DtVreMessageId& messageId() const override;
59
60 // default destructor
62
63 virtual const std::string& getSourceChannel() const;
64 virtual void setSourceChannel(const std::string& val);
65
66 virtual const std::string& getSourceWindow() const;
67 virtual void setSourceWindow(const std::string& val);
68
69 virtual const std::string& getDestinationChannel() const;
70 virtual void setDestinationChannel(const std::string& val);
71
72 virtual const std::string& getDestinationWindow() const;
73 virtual void setDestinationWindow(const std::string& val);
74
75
76 // Accessors
77 virtual int messageSize() const override;
78 static makVre::DtVreMessage* decode(char* buffer, int length);
81
82 // Operators
84
85protected:
86 // Inaccessible default constructor to promote the usage of the static creator functions
88
89 virtual void serialize(DtStreamWriter& writer) const override;
90 virtual void deserialize(DtStreamReader& reader) override;
91
92protected:
95
96 // Store the data for future use
98};
99
100} // ::makVre
101
102
103
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
static makVre::DtVreMessageId theMessageId
Definition addChannelEventProcessorAssociation.h:93
virtual const std::string & getSourceWindow() const
AddChannelEventProcessorAssociationData getData()
static const makVre::DtVreMessageId & theId()
static const std::string & theType()
static message identity functions
bool operator==(const AddChannelEventProcessorAssociationMessage &rhs) const
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
virtual const std::string & getSourceChannel() const
static UInt64 theVersion
Definition addChannelEventProcessorAssociation.h:94
virtual void setSourceChannel(const std::string &val)
virtual const std::string & type() const override
Get the name of the message type.
virtual void setSourceWindow(const std::string &val)
static AddChannelEventProcessorAssociationMessage * createFrom(AddChannelEventProcessorAssociationMessage *)
static AddChannelEventProcessorAssociationMessage * create()
virtual void setDestinationChannel(const std::string &val)
virtual void setDestinationWindow(const std::string &val)
static AddChannelEventProcessorAssociationMessage * createFromData(const AddChannelEventProcessorAssociationData)
AddChannelEventProcessorAssociationData getData() const
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual const std::string & getDestinationWindow() const
virtual int messageSize() const override
Static decode function pattern for derived classes.
virtual const std::string & getDestinationChannel() const
AddChannelEventProcessorAssociationData myData
Definition addChannelEventProcessorAssociation.h:97
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
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
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 * AddChannelEventProcessorAssociationMessageType
Definition addChannelEventProcessorAssociation.h:26
bool operator==(const AddChannelEventProcessorAssociationData &rhs) const
std::string myDestinationWindow
Definition addChannelEventProcessorAssociation.h:41
std::string mySourceWindow
Definition addChannelEventProcessorAssociation.h:39
std::string mySourceChannel
Definition addChannelEventProcessorAssociation.h:38
std::string myDestinationChannel
Definition addChannelEventProcessorAssociation.h:40
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.