menuSetState.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 show, hide or toggle action menus and quick menus. Handled by DtMenuManager.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* MenuSetStateMessageType = "menu.set.state";
 
class VREMESSAGES_DLL MenuSetStateMessage : public makVre::DtVreMessage
{
public:
   enum State {State_SHOW, State_HIDE, State_TOGGLE};
   enum Type {Type_STATIC, Type_QUICK};
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL MenuSetStateData 
   {
      MenuSetStateData();
 
      std::string myMenu;
      State myState;
      std::string myDefaultSelection;
      Type myType;
 
      bool operator==(const MenuSetStateData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static MenuSetStateMessage* create();
   static MenuSetStateMessage* createFrom(MenuSetStateMessage*);
   static MenuSetStateMessage* createFromData(const MenuSetStateData);
   
   //! \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 ~MenuSetStateMessage() override;
 
   virtual const std::string& getMenu() const;
   virtual void setMenu(const std::string& val);
 
   virtual State getState() const;
   virtual void setState(State val);
 
   virtual const std::string& getDefaultSelection() const;
   virtual void setDefaultSelection(const std::string& val);
 
   virtual Type getType() const;
   virtual void setType(Type val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   MenuSetStateData getData();
   MenuSetStateData getData() const;
 
   // Operators
   bool operator==(const MenuSetStateMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   MenuSetStateMessage();
 
   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
   MenuSetStateData myData;
};
 
} // ::makVre