VR-Engage  2.2
Loading...
Searching...
No Matches
debugDrawLine.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 a line. 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* DebugDrawLineMessageType = "debug.render.line";
29
30class VREDEBUGMANAGER_DLL DebugDrawLineMessage : public makVre::DtVreMessage
31{
32public:
33
34
35 // Struct for defining data
36 struct VREDEBUGMANAGER_DLL DebugDrawLineData
37 {
39
40 std::string myLayerName;
41 std::string myLayerId;
42 DtVector myStart;
43 DtVector myEnd;
45 bool myClip;
46 double myDuration;
47
48 bool operator==(const DebugDrawLineData& rhs) const;
49 };
50
51 // Default static creators to promote the usage of not using new.
55
56 //! \brief static message identity functions
57 static const std::string& theType();
60
61 //! \brief Get the name of the message type
62 virtual const std::string& type() const override;
63 virtual const makVre::DtVreMessageId& messageId() const override;
64
65 // default destructor
66 virtual ~DebugDrawLineMessage() override;
67
68 virtual const std::string& getLayerName() const;
69 virtual void setLayerName(const std::string& val);
70
71 virtual const std::string& getLayerId() const;
72 virtual void setLayerId(const std::string& val);
73
74 virtual const DtVector& getStart() const;
75 virtual void setStart(const DtVector& val);
76
77 virtual const DtVector& getEnd() const;
78 virtual void setEnd(const DtVector& val);
79
80 virtual const makVre::DtColor& getColor() const;
81 virtual void setColor(const makVre::DtColor& val);
82
83 virtual bool getClip() const;
84 virtual void setClip(bool val);
85
86 virtual double getDuration() const;
87 virtual void setDuration(double val);
88
89
90 // Accessors
91 virtual int messageSize() const override;
92 static makVre::DtVreMessage* decode(char* buffer, int length);
95
96 // Operators
97 bool operator==(const DebugDrawLineMessage& rhs) const;
98
99protected:
100 // Inaccessible default constructor to promote the usage of the static creator functions
102
103 virtual void serialize(DtStreamWriter& writer) const override;
104 virtual void deserialize(DtStreamReader& reader) override;
105
106protected:
109
110 // Store the data for future use
112};
113
114} // ::makVre
115
116
117
DebugDrawLineData myData
Definition debugDrawLine.h:111
virtual void setEnd(const DtVector &val)
virtual const DtVector & getEnd() const
virtual void serialize(DtStreamWriter &writer) const override
Serializes the message to a stream writer.
virtual const std::string & type() const override
Get the name of the message type.
virtual void deserialize(DtStreamReader &reader) override
Deserializes the message from a stream reader.
virtual const std::string & getLayerId() const
virtual void setClip(bool val)
virtual const makVre::DtVreMessageId & messageId() const override
Gets the message ID object.
virtual double getDuration() const
virtual int messageSize() const override
Static decode function pattern for derived classes.
static UInt64 theVersion
Definition debugDrawLine.h:108
virtual const DtVector & getStart() const
virtual ~DebugDrawLineMessage() override
static DebugDrawLineMessage * createFromData(const DebugDrawLineData)
DebugDrawLineData getData()
static UInt64 theVersionNumber()
virtual void setDuration(double val)
static makVre::DtVreMessageId theMessageId
Definition debugDrawLine.h:107
static DebugDrawLineMessage * createFrom(DebugDrawLineMessage *)
DebugDrawLineData getData() const
virtual void setLayerName(const std::string &val)
virtual void setStart(const DtVector &val)
static const makVre::DtVreMessageId & theId()
bool operator==(const DebugDrawLineMessage &rhs) const
virtual void setLayerId(const std::string &val)
virtual const std::string & getLayerName() const
virtual bool getClip() const
static DebugDrawLineMessage * create()
static const std::string & theType()
static message identity functions
virtual void setColor(const makVre::DtColor &val)
static makVre::DtVreMessage * decode(char *buffer, int length)
virtual const makVre::DtColor & getColor() const
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
constexpr const char * DebugDrawLineMessageType
Definition debugDrawLine.h:28
unsigned long long UInt64
Unsigned 64-bit integer type.
Definition utilFunctions.h:42
std::string myLayerName
Definition debugDrawLine.h:40
makVre::DtColor myColor
Definition debugDrawLine.h:44
bool operator==(const DebugDrawLineData &rhs) const
DtVector myEnd
Definition debugDrawLine.h:43
double myDuration
Definition debugDrawLine.h:46
bool myClip
Definition debugDrawLine.h:45
DtVector myStart
Definition debugDrawLine.h:42
std::string myLayerId
Definition debugDrawLine.h:41
Defines the base class for all VREngage messages.
Defines message identifier class for the VREngage messaging system.