3dGraphicalObjectStateRecord.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 <vrfExtObjects/attachmentDescriptor.h>

#include <vl/globalObjectDesignatorList.h>
#include <vl/environmentalRecord.h>
#include <vl/packets/envProcP.h>
#include <vlpi/disEnums.h>

#include <vector>

struct DtNet3DGraphicalObjectStateRecord : DtNetEnvironmentalRecord
{
   DtNetVector32 myOffset;
   DtNetU8       myColor[4];
   DtNetInt32    myFillPattern;
   DtNetBoolean  myFlashing;
   DtNetU8       myForceType;
   DtNetBoolean  myProjected;
   DtNetBoolean  myBound2D;
   DtNetU8       myNumberOfApplicationIds;
   DtNetU8       myNumberOfAttachments;
   DtNetU8       myNumberOfParentOverlays;
   DtNetU8       myLabelSize;
   DtNetU16      myUserDataSize;
};


class DT_DLL_vrfExtObjects Dt3DGraphicalObjectStateRecord : public DtEnvironmentalRecord
{
public:
   Dt3DGraphicalObjectStateRecord();

   Dt3DGraphicalObjectStateRecord(
      const Dt3DGraphicalObjectStateRecord& orig);

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

   virtual ~Dt3DGraphicalObjectStateRecord() override;

   virtual DtEnvironmentalRecord *clone() const override;

   virtual void setOffset(const DtVector32& pos);
   virtual const DtVector32& offset() const;

   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 void setForceType(DtForceType forceType);
   virtual DtForceType forceType() const;

   virtual void setProjected(bool yesNo);
   virtual bool projected() const;

   virtual void setBound2D(bool yesNo);
   virtual bool bound2D() 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 setNumberOfAttachments(int newNumberOfAppIds);
   virtual int numberOfAttachments() const;

   virtual bool setAttachment(int index, const DtAttachmentDescriptor& desc,
      const DtGlobalObjectDesignator& attachId);

   virtual bool getAttachment(int index, DtAttachmentDescriptor& desc,
      DtGlobalObjectDesignator& attachId) const;

   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 setLabel(const DtString& label);
   virtual const DtString& label() const;

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

   virtual bool createNetworkRepresentation() override;

   const DtNet3DGraphicalObjectStateRecord* objectNetRep() const;
   DtNet3DGraphicalObjectStateRecord* objectNetRep();

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

   virtual int netRepSize() const override;

protected:

   virtual bool resizeNetRep(int newSize) override;

   // 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* pointerToApplicationIds() const;
   virtual void* pointerToAttachmentList() const;
   virtual void* pointerToAttachmentIdList() const;
   virtual void* pointerToParentOverlays() const;
   virtual void* pointerToLabel() const;
   virtual void* pointerToUserData() const;

protected:

   DtVector32                   myOffset;
   int                          myColorR;
   int                          myColorG;
   int                          myColorB;
   int                          myColorA;
   int                          myFillPattern;
   bool                         myFlashing;
   DtForceType                  myForceType;
   bool                         myProjected;
   bool                         myBound2D;
   DtGlobalObjectDesignatorList myApplicationIds;
   DtAttachmentDescriptorList   myAttachments;
   DtGlobalObjectDesignatorList myAttachmentIds;
   DtStringList                 myParentOverlays;
   DtString                     myLabel;
   char*                        myUserData;
   int                          myUserDataLength;

   int myNetRepSize;

};