2dGraphicalObjectStateRecord.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2025 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vrfExtObjects/stringList.h>
#include <vl/globalObjectDesignatorList.h>
#include <vl/environmentalRecord.h>
#include <vl/packets/envProcP.h>
#include <vlpi/disEnums.h>
#include <vector>

struct DtNet2DGraphicalObjectStateRecord : DtNetEnvironmentalRecord
{
   DtNetU8       myColor[4];
   DtNetInt32    myFillPattern;
   DtNetBoolean  myFlashing;
   DtNetU8       myNumberOfApplicationIds;
   DtNetU8       myNumberOfVertices;
   DtNetU8       myNumberOfParentOverlays;
   DtNetU16      myUserDataSize;
   DtNetU8       myWindowNameSize;
   DtNetU8       myPadding;
};


class DT_DLL_vrfExtObjects Dt2DGraphicalObjectStateRecord : public DtEnvironmentalRecord
{
public:

   Dt2DGraphicalObjectStateRecord();

   Dt2DGraphicalObjectStateRecord(
      const Dt2DGraphicalObjectStateRecord& orig);

   const Dt2DGraphicalObjectStateRecord& operator=(
      const Dt2DGraphicalObjectStateRecord& orig);

   virtual ~Dt2DGraphicalObjectStateRecord() override;

   virtual DtEnvironmentalRecord *clone() const override;

   virtual void setColor(int r, int g, int b, int a);
   virtual void getColor(int& r, int& g, int& b, int& a) const;

   virtual void setFillPattern(int pattern);
   virtual int fillPattern() const;

   virtual void setFlashing(bool yesNo);
   virtual bool flashing() const;

   virtual bool setNumberOfApplicationIds(int newNumberOfAppIds);
   virtual int numberOfApplicationIds() const;

   virtual bool setApplicationId(int index,
      const DtGlobalObjectDesignator& subID);

   virtual bool getApplicationId(int index, DtGlobalObjectDesignator& subID)
      const;

   virtual bool setNumberOfVertices(unsigned int newNumberOfVertices);
   virtual unsigned int numberOfVertices() const;

   virtual bool setVertex(unsigned int index, const DtVector32& loc);
   virtual bool getVertex(unsigned int index, DtVector32& loc);

   virtual bool setNumberOfParentOverlays(int newNumberOfParentOverlays);
   virtual int numberOfParentOverlays() const;

   virtual bool setParentOverlay(int index,
      const DtString& name);

   virtual bool getParentOverlay(int index, DtString& name) const;

   virtual void setWindowName(const DtString& name);
   virtual const DtString& windowName() const;

   virtual void setUserData(const char* data, int length);
   virtual const char* userData(int* length = 0) const;

   virtual bool createNetworkRepresentation() override;

   const DtNet2DGraphicalObjectStateRecord* objectNetRep() const;
   DtNet2DGraphicalObjectStateRecord* objectNetRep();

   virtual void setFromNet(const DtNetEnvironmentalRecord &buffer,
                           int protocolVersion) override;

   virtual int netRepSize() const override;

protected:

   virtual bool resizeNetRep(int newSize) override;

   virtual int verticesNetSize() const;

   // These functions do the pointer math to get a pointer to
   // the right place in the internal buffer for the start of these
   // data areas.
   virtual void* pointerToVertices() const;
   virtual void* pointerToApplicationIds() const;
   virtual void* pointerToParentOverlays() const;
   virtual void* pointerToWindowName() const;
   virtual void* pointerToUserData() const;

protected:

   int                          myColorR;
   int                          myColorG;
   int                          myColorB;
   int                          myColorA;
   int                          myFillPattern;
   bool                         myFlashing;
   std::vector<DtVector32>      myVertices;
   DtGlobalObjectDesignatorList myApplicationIds;
   DtStringList                 myParentOverlays;
   DtString                     myWindowName;
   char*                        myUserData;
   int                          myUserDataLength;

   int myNetRepSize;

};