menuInput.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----------------------
Used to interact with the action menu and quick menus using keyboard, gamepad or joystick input.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
 
 
namespace makVre
{
 
 
constexpr const char* MenuInputMessageType = "menu.input";
 
class VREMESSAGES_DLL MenuInputMessage : public makVre::DtVreMessage
{
public:
   enum Input {Input_UP, Input_DOWN, Input_PAGE_UP, Input_PAGE_DOWN, Input_LEFT, Input_RIGHT, Input_ACCEPT, Input_CANCEL, Input_KEY};
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL MenuInputData 
   {
      MenuInputData();
 
      Input myInput;
      int myItem;
 
      bool operator==(const MenuInputData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static MenuInputMessage* create();
   static MenuInputMessage* createFrom(MenuInputMessage*);
   static MenuInputMessage* createFromData(const MenuInputData);
   
   //! \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 ~MenuInputMessage() override;
 
   virtual Input getInput() const;
   virtual void setInput(Input val);
 
   virtual int getItem() const;
   virtual void setItem(int val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   MenuInputData getData();
   MenuInputData getData() const;
 
   // Operators
   bool operator==(const MenuInputMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   MenuInputMessage();
 
   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
   MenuInputData myData;
};
 
} // ::makVre