debugDrawTextPanel.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/
 
/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!This is an auto-generated file.  Any changes will be destroyed!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
Generated from: /data/exports/DEV-CAM-BML-043/nightly/3085/libsrc/utilities/vreDebugManager/debugRenderer.lua
*/
/*-----------------COMMENT----------------------
Send to render a text panel. Enable and disable in VR-Engage debug menu in the rendering page.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreDebugManager/export.h>
#include <string>
#include <vreUtil/color.h>
 
 
namespace makVre
{
 
 
constexpr const char* DebugDrawTextPanelMessageType = "debug.render.textPanel";
 
class VREDEBUGMANAGER_DLL DebugDrawTextPanelMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREDEBUGMANAGER_DLL DebugDrawTextPanelData 
   {
      DebugDrawTextPanelData();
 
      std::string myLayerName;
      std::string myLayerId;
      std::string myPanel;
      std::string myText;
      makVre::DtColor myColor;
      bool myTop;
      double myDuration;
 
      bool operator==(const DebugDrawTextPanelData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static DebugDrawTextPanelMessage* create();
   static DebugDrawTextPanelMessage* createFrom(DebugDrawTextPanelMessage*);
   static DebugDrawTextPanelMessage* createFromData(const DebugDrawTextPanelData);
   
   //! \brief static message identity functions
   static const std::string& theType();
   static const makVre::DtVreMessageId& theId();
   static UInt64 theVersionNumber();
 
   //! \brief Get the name of the message type
   virtual const std::string& type() const override;
   virtual const makVre::DtVreMessageId& messageId() const override;
 
   // default destructor
   virtual ~DebugDrawTextPanelMessage() override;
 
   virtual const std::string& getLayerName() const;
   virtual void setLayerName(const std::string& val);
 
   virtual const std::string& getLayerId() const;
   virtual void setLayerId(const std::string& val);
 
   virtual const std::string& getPanel() const;
   virtual void setPanel(const std::string& val);
 
   virtual const std::string& getText() const;
   virtual void setText(const std::string& val);
 
   virtual const makVre::DtColor& getColor() const;
   virtual void setColor(const makVre::DtColor& val);
 
   virtual bool getTop() const;
   virtual void setTop(bool val);
 
   virtual double getDuration() const;
   virtual void setDuration(double val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   DebugDrawTextPanelData getData();
   DebugDrawTextPanelData getData() const;
 
   // Operators
   bool operator==(const DebugDrawTextPanelMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   DebugDrawTextPanelMessage();
 
   virtual void serialize(DtStreamWriter& writer) const override;
   virtual void deserialize(DtStreamReader& reader) override;
 
protected:
   static makVre::DtVreMessageId theMessageId;
   static UInt64 theVersion;
 
   // Store the data for future use
   DebugDrawTextPanelData myData;
};
 
} // ::makVre