VR-Engage  2.2
Loading...
Searching...
No Matches
debugDrawText2d.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/utilities/vreDebugManager/debugRenderer.lua
10*/
11/*-----------------COMMENT----------------------
12Send to render 2d text. Enable and disable in VR-Engage debug menu in the rendering page.
13-------------------COMMENT----------------------*/
14#pragma once
15
19#include <string>
20#include <matrix/vlVector.h>
21#include <vreUtil/color.h>
22
23
24namespace makVre
25{
26
27
28constexpr const char* DebugDrawText2dMessageType = "debug.render.text2d";
29
30class VREDEBUGMANAGER_DLL DebugDrawText2dMessage : public makVre::DtVreMessage
31{
32public:
33
34
35 // Struct for defining data
36 struct VREDEBUGMANAGER_DLL DebugDrawText2dData
37 {
39
40 std::string myLayerName;
41 std::string myLayerId;
42 DtVector myPosition;
43 std::string myText;
45 double myDuration;
46
47 bool operator==(const DebugDrawText2dData& 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 ~DebugDrawText2dMessage() override;
66
67 virtual const std::string& getLayerName() const;
68 virtual void setLayerName(const std::string& val);
69
70 virtual const std::string& getLayerId() const;
71 virtual void setLayerId(const std::string& val);
72
73 virtual const DtVector& getPosition() const;
74 virtual void setPosition(const DtVector& val);
75
76 virtual const std::string& getText() const;
77 virtual void setText(const std::string& val);
78
79 virtual const makVre::DtColor& getColor() const;
80 virtual void setColor(const makVre::DtColor& val);
81
82 virtual double getDuration() const;
83 virtual void setDuration(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 DebugDrawText2dMessage& 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
virtual const makVre::DtColor & getColor() const
virtual void setLayerId(const std::string &val)
virtual void setColor(const makVre::DtColor &val)
virtual void setDuration(double val)
virtual const std::string & getLayerName() const
static const std::string & theType()
static message identity functions
static UInt64 theVersionNumber()
virtual void setLayerName(const std::string &val)
DebugDrawText2dData getData()
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual const std::string & getLayerId() const
static DebugDrawText2dMessage * createFrom(DebugDrawText2dMessage *)
static UInt64 theVersion
Definition debugDrawText2d.h:104
virtual const std::string & getText() const
virtual ~DebugDrawText2dMessage() override
virtual void setText(const std::string &val)
static makVre::DtVreMessageId theMessageId
Definition debugDrawText2d.h:103
static makVre::DtVreMessage * decode(char *buffer, int length)
DebugDrawText2dData getData() const
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual const std::string & type() const override
Get the name of the message type.
bool operator==(const DebugDrawText2dMessage &rhs) const
virtual int messageSize() const override
Static decode function pattern for derived classes.
static const makVre::DtVreMessageId & theId()
static DebugDrawText2dMessage * createFromData(const DebugDrawText2dData)
static DebugDrawText2dMessage * create()
virtual const DtVector & getPosition() const
virtual double getDuration() const
virtual void setPosition(const DtVector &val)
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
DebugDrawText2dData myData
Definition debugDrawText2d.h:107
Class for representing and manipulating RGBA colors.
Definition color.h:22
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
Provides color representation and manipulation functionality.
Defines export macros for the VREngage Debug Manager library.
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 * DebugDrawText2dMessageType
Definition debugDrawText2d.h:28
makVre::DtColor myColor
Definition debugDrawText2d.h:44
double myDuration
Definition debugDrawText2d.h:45
std::string myLayerId
Definition debugDrawText2d.h:41
bool operator==(const DebugDrawText2dData &rhs) const
std::string myText
Definition debugDrawText2d.h:43
std::string myLayerName
Definition debugDrawText2d.h:40
DtVector myPosition
Definition debugDrawText2d.h:42
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.