windowOperation.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/windowOperations.lua
*/
/*-----------------COMMENT----------------------
Used to create, modify or destroy a window or channel.
-------------------COMMENT----------------------*/
#pragma once
 
#include <vreMessageManager/vreMessage.h>
#include <vreMessageManager/vreMessageId.h>
#include <vreMessages/export.h>
#include <string>
#include <vlpi/entityIdentifier.h>
#include <matrix/vlVector.h>
#include <vector>
 
 
namespace makVre
{
 
 
constexpr const char* WindowOperationMessageType = "ownship.windowOperation";
 
class VREMESSAGES_DLL WindowOperationMessage : public makVre::DtVreMessage
{
public:
   enum OperationType {OperationType_Create, OperationType_Modify, OperationType_Destroy};
   enum WindowType {WindowType_Gimbal, WindowType_PVD, WindowType_Stealth, WindowType_InstrumentPanel, WindowType_Any};
 
 
   // Struct for defining data
   struct VREMESSAGES_DLL WindowOperationData 
   {
      WindowOperationData();
 
      std::string myMarking;
      DtEntityIdentifier myOwnshipEntityId;
      DtEntityIdentifier myPanelHostEntityId;
      OperationType myOperation;
      WindowType myWindowType;
      std::string mySensorMode;
      std::string myModelDefinition;
      DtVector myWindowPosition;
      DtVector myWindowSize;
      int myScreen;
      bool myIsFullScreen;
      DtEntityIdentifier myModifyAttachedId;
      std::string myModifyAttachedMarkingText;
      DtVector myModifyAttachedOffset;
      std::string myChannelName;
      double myZoomLevel;
      double myViewportLeft;
      double myViewportRight;
      double myViewportBottom;
      double myViewportTop;
      bool myRtt;
      std::string myReplaceTexture;
      bool myHasTransparency;
      double myZNear;
      double myZFar;
      double myFov;
      bool myAttachStealthAsGimbal;
      std::string myStealthObserverMode;
      int myInitialScale;
      std::vector<std::string> myAdditionalChannelKeywords;
      std::string myPanelId;
      bool myCockpitOnly;
      DtVector myLocationTrackAttachment;
      std::string myObjectTrackAttachment;
 
      bool operator==(const WindowOperationData& rhs) const;
   };
 
   // Default static creators to promote the usage of not using new.
   static WindowOperationMessage* create();
   static WindowOperationMessage* createFrom(WindowOperationMessage*);
   static WindowOperationMessage* createFromData(const WindowOperationData);
   
   //! \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 ~WindowOperationMessage() override;
 
   virtual const std::string& getMarking() const;
   virtual void setMarking(const std::string& val);
 
   virtual const DtEntityIdentifier& getOwnshipEntityId() const;
   virtual void setOwnshipEntityId(const DtEntityIdentifier& val);
 
   virtual const DtEntityIdentifier& getPanelHostEntityId() const;
   virtual void setPanelHostEntityId(const DtEntityIdentifier& val);
 
   virtual OperationType getOperation() const;
   virtual void setOperation(OperationType val);
 
   virtual WindowType getWindowType() const;
   virtual void setWindowType(WindowType val);
 
   virtual const std::string& getSensorMode() const;
   virtual void setSensorMode(const std::string& val);
 
   virtual const std::string& getModelDefinition() const;
   virtual void setModelDefinition(const std::string& val);
 
   virtual const DtVector& getWindowPosition() const;
   virtual void setWindowPosition(const DtVector& val);
 
   virtual const DtVector& getWindowSize() const;
   virtual void setWindowSize(const DtVector& val);
 
   virtual int getScreen() const;
   virtual void setScreen(int val);
 
   virtual bool getIsFullScreen() const;
   virtual void setIsFullScreen(bool val);
 
   virtual const DtEntityIdentifier& getModifyAttachedId() const;
   virtual void setModifyAttachedId(const DtEntityIdentifier& val);
 
   virtual const std::string& getModifyAttachedMarkingText() const;
   virtual void setModifyAttachedMarkingText(const std::string& val);
 
   virtual const DtVector& getModifyAttachedOffset() const;
   virtual void setModifyAttachedOffset(const DtVector& val);
 
   virtual const std::string& getChannelName() const;
   virtual void setChannelName(const std::string& val);
 
   virtual double getZoomLevel() const;
   virtual void setZoomLevel(double val);
 
   virtual double getViewportLeft() const;
   virtual void setViewportLeft(double val);
 
   virtual double getViewportRight() const;
   virtual void setViewportRight(double val);
 
   virtual double getViewportBottom() const;
   virtual void setViewportBottom(double val);
 
   virtual double getViewportTop() const;
   virtual void setViewportTop(double val);
 
   virtual bool getRtt() const;
   virtual void setRtt(bool val);
 
   virtual const std::string& getReplaceTexture() const;
   virtual void setReplaceTexture(const std::string& val);
 
   virtual bool getHasTransparency() const;
   virtual void setHasTransparency(bool val);
 
   virtual double getZNear() const;
   virtual void setZNear(double val);
 
   virtual double getZFar() const;
   virtual void setZFar(double val);
 
   virtual double getFov() const;
   virtual void setFov(double val);
 
   virtual bool getAttachStealthAsGimbal() const;
   virtual void setAttachStealthAsGimbal(bool val);
 
   virtual const std::string& getStealthObserverMode() const;
   virtual void setStealthObserverMode(const std::string& val);
 
   virtual int getInitialScale() const;
   virtual void setInitialScale(int val);
 
   virtual const std::vector<std::string>& getAdditionalChannelKeywords() const;
   virtual void setAdditionalChannelKeywords(const std::vector<std::string>& val);
 
   virtual const std::string& getPanelId() const;
   virtual void setPanelId(const std::string& val);
 
   virtual bool getCockpitOnly() const;
   virtual void setCockpitOnly(bool val);
 
   virtual const DtVector& getLocationTrackAttachment() const;
   virtual void setLocationTrackAttachment(const DtVector& val);
 
   virtual const std::string& getObjectTrackAttachment() const;
   virtual void setObjectTrackAttachment(const std::string& val);
 
 
   // Accessors
   virtual int messageSize() const override;
   static makVre::DtVreMessage* decode(char* buffer, int length);
   WindowOperationData getData();
   WindowOperationData getData() const;
 
   // Operators
   bool operator==(const WindowOperationMessage& rhs) const;
 
protected:
   // Inaccessible default constructor to promote the usage of the static creator functions
   WindowOperationMessage();
 
   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
   WindowOperationData myData;
};
 
} // ::makVre