cigiViewDefinition.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/cigiHostControl.lua
*/
 
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <vlpi/simulationAddress.h>
#include <string>
 
 
namespace makVre
{
 
 
constexpr const char* VreCigiViewDefinitionMessageType = "cigi.control.viewDefinition";
 
class VREMESSAGES_DLL VreCigiViewDefinitionMessage : public makVre::DtVreMessage
{
public:
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL VreCigiViewDefinitionData 
   {
      VreCigiViewDefinitionData();
 
      DtSimulationAddress myHostSimAddress;
      std::string mySessionName;
      int myViewId;
      int myGroupId;
      bool myMirror;
      int myPixelZoom;
      bool myOrtho;
      bool myKeepOnTop;
      std::string mySensor;
      float myNear;
      float myFar;
      float myLeft;
      float myRight;
      float myTop;
      float myBottom;
      float myMaxViewDistance;
      float myMinFovDistance;
      float myMaxFireFxDistance;
 
      bool operator==(const VreCigiViewDefinitionData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static VreCigiViewDefinitionMessage* create();
   static VreCigiViewDefinitionMessage* createFrom(VreCigiViewDefinitionMessage*);
   static VreCigiViewDefinitionMessage* createFromData(const VreCigiViewDefinitionData);
   
   //! \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 ~VreCigiViewDefinitionMessage() override;
 
   virtual const DtSimulationAddress& getHostSimAddress() const;
   virtual void setHostSimAddress(const DtSimulationAddress& val);
 
   virtual const std::string& getSessionName() const;
   virtual void setSessionName(const std::string& val);
 
   virtual int getViewId() const;
   virtual void setViewId(int val);
 
   virtual int getGroupId() const;
   virtual void setGroupId(int val);
 
   virtual bool getMirror() const;
   virtual void setMirror(bool val);
 
   virtual int getPixelZoom() const;
   virtual void setPixelZoom(int val);
 
   virtual bool getOrtho() const;
   virtual void setOrtho(bool val);
 
   virtual bool getKeepOnTop() const;
   virtual void setKeepOnTop(bool val);
 
   virtual const std::string& getSensor() const;
   virtual void setSensor(const std::string& val);
 
   virtual float getNear() const;
   virtual void setNear(float val);
 
   virtual float getFar() const;
   virtual void setFar(float val);
 
   virtual float getLeft() const;
   virtual void setLeft(float val);
 
   virtual float getRight() const;
   virtual void setRight(float val);
 
   virtual float getTop() const;
   virtual void setTop(float val);
 
   virtual float getBottom() const;
   virtual void setBottom(float val);
 
   virtual float getMaxViewDistance() const;
   virtual void setMaxViewDistance(float val);
 
   virtual float getMinFovDistance() const;
   virtual void setMinFovDistance(float val);
 
   virtual float getMaxFireFxDistance() const;
   virtual void setMaxFireFxDistance(float val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   VreCigiViewDefinitionData getData();
   VreCigiViewDefinitionData getData() const;
 
   // Operators
   bool operator==(const VreCigiViewDefinitionMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   VreCigiViewDefinitionMessage();
 
   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
   VreCigiViewDefinitionData myData;
};
 
} // ::makVre