menuAction.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/framework/vreMessages/actionMenu.lua
*/
/*-----------------COMMENT----------------------
Sent when the user activates an action menu element. entityId is the host entity. parameter is optional depending on the action itself.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
#include <vlpi/entityIdentifier.h>
 
 
namespace makVre
{
 
 
constexpr const char* MenuActionMessageType = "menu.action";
 
class VREMESSAGES_DLL MenuActionMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL MenuActionData 
   {
      MenuActionData();
 
      std::string myAction;
      std::string myParameter;
      DtEntityIdentifier myEntityId;
 
      bool operator==(const MenuActionData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static MenuActionMessage* create();
   static MenuActionMessage* createFrom(MenuActionMessage*);
   static MenuActionMessage* createFromData(const MenuActionData);
   
   //! \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 ~MenuActionMessage() override;
 
   virtual const std::string& getAction() const;
   virtual void setAction(const std::string& val);
 
   virtual const std::string& getParameter() const;
   virtual void setParameter(const std::string& val);
 
   virtual const DtEntityIdentifier& getEntityId() const;
   virtual void setEntityId(const DtEntityIdentifier& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   MenuActionData getData();
   MenuActionData getData() const;
 
   // Operators
   bool operator==(const MenuActionMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   MenuActionMessage();
 
   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
   MenuActionData myData;
};
 
} // ::makVre