joystick.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/joystick.lua
*/
/*-----------------COMMENT----------------------
Send from any VR-Engage thread to cause the DtVrfRemoteControlConnector to generate a VR-Forces joystick message.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/entityIdentifier.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* JoystickMessageType = "system.input.joystick";
 
class VREMESSAGES_DLL JoystickMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL JoystickData 
   {
      JoystickData();
 
      DtEntityIdentifier myEntityId;
      std::string myFunctionGroup;
      std::string myFunction;
      double myValue;
      bool myRepeat;
 
      bool operator==(const JoystickData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static JoystickMessage* create();
   static JoystickMessage* createFrom(JoystickMessage*);
   static JoystickMessage* createFromData(const JoystickData);
   
   //! \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 ~JoystickMessage() override;
 
   virtual const DtEntityIdentifier& getEntityId() const;
   virtual void setEntityId(const DtEntityIdentifier& val);
 
   virtual const std::string& getFunctionGroup() const;
   virtual void setFunctionGroup(const std::string& val);
 
   virtual const std::string& getFunction() const;
   virtual void setFunction(const std::string& val);
 
   virtual double getValue() const;
   virtual void setValue(double val);
 
   virtual bool getRepeat() const;
   virtual void setRepeat(bool val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   JoystickData getData();
   JoystickData getData() const;
 
   // Operators
   bool operator==(const JoystickMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   JoystickMessage();
 
   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
   JoystickData myData;
};
 
} // ::makVre