controlObjectBaseRepository.h

Go to the documentation of this file.

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


#pragma once

#include <vl/environmentProcessRepository.h>
#include <vrfExtObjects/vrfExtensions.h>
#include <vrfExtProtocol/vrfExtendedRecordData.h>
#include <vrfExtProtocol/vrfObjectAttachEnums.h>
#include <vlpi/appearance.h>

#include <vrfExtObjects/ittEnvironmentalProcessRecords.h>
#include <vrfExtObjects/ittEnvironmentalProcessData.h>

class Dt3dBoundingVolume;

#include <vector>
#include <map>

class DtSimEnvironmentalObjectStateRecord;
class DtSimEnvironmentalModelType;
class DtEnvironmentalBoundingSphereRecord;
class DtEnvironmentalRectangularVolumeRecord;
class DtVrfObjectDataEnvironmentalRecord;
class DtGlobalObjectDesignatorList;

enum DtControlObjectKind
{
   DtControlObjectKindUnknown,
   DtControlObjectKindPoint,
   DtControlObjectKindLine,
   DtControlObjectKindArea,
   DtControlObjectKindCircle,
   DtControlObjectKindText,
   DtControlObjectKindPuff
};

enum DtControlObjectCategory
{
   DtControlObjectCategoryUnknown,
   DtControlObjectCategoryPointOther,
   DtControlObjectCategoryControlPoint,
   DtControlObjectCategoryTargetPoint,
   DtControlObjectCategoryMarkerPoint,
   DtControlObjectCategoryLineOther,
   DtControlObjectCategoryPhaseLine,
   DtControlObjectCategoryRouteLine,
   DtControlObjectCategoryAreaOther,
   DtControlObjectCategoryControlArea,
   DtControlObjectCategoryObstacleArea,
   DtControlObjectCategoryPuff,
   DtControlObjectCategoryDisaggregationArea
};

class DtEnvironmentalPointRecord;

#include <vrfExtObjects/dllExport.h>

class DT_DLL_vrfExtObjects DtExtendedEnvironmentalDataRecord : public DtEnvironmentalRecord
{
public:

   DtExtendedEnvironmentalDataRecord(const char* data, int length);
   DtExtendedEnvironmentalDataRecord();

   DtExtendedEnvironmentalDataRecord(
      const DtExtendedEnvironmentalDataRecord& orig);

   virtual ~DtExtendedEnvironmentalDataRecord() override;

   DtExtendedEnvironmentalDataRecord& operator=(const DtExtendedEnvironmentalDataRecord& orig);

   virtual DtEnvironmentalRecord *clone() const override;

   virtual const char* networkData() const;
   virtual const char* setNetworkData(const DtNetEnvironmentalRecord*);

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

protected:
   virtual bool createNetworkRepresentation() override;
   virtual bool resizeNetRep(int newSize) override;

protected:
   int                  myDataSize;
   const char*          myData;
};

class DtControlObjectBaseRepository;

class DT_DLL_vrfExtObjects DtEnvironmentalProcessExtendedRecordData : public DtVrfExtendedRecordData
{
public:
   DtEnvironmentalProcessExtendedRecordData();

   virtual ~DtEnvironmentalProcessExtendedRecordData() override;

   virtual void updateDataRecords(DtControlObjectBaseRepository*);

   virtual void decodeDataRecords(DtControlObjectBaseRepository*);

   virtual bool readFromRecord(const DtNetEnvironmentalRecord*);
};

class DT_DLL_vrfExtObjects DtControlObjectBaseRepository : public DtEnvironmentProcessRepository, public DtVrfExtensions
{
public:
   typedef std::vector<DtVector> DtCOVertexList;
   typedef std::vector<DtIttEnvironmentalProcessData*> DtGeometricDataList;
   typedef std::map<int, DtIttSourceDataCreator> DtIttSourceDataMap;

public:

   DtControlObjectBaseRepository();

   virtual ~DtControlObjectBaseRepository() override;

   DtControlObjectBaseRepository(const DtControlObjectBaseRepository& orig);

   DtControlObjectBaseRepository& operator=(const DtControlObjectBaseRepository& orig);

   virtual DtStateRepository *clone(bool copy = false) const override;

   DtEntityType entityType() const { return environmentType(); };
   DtEntityType objectType() const { return entityType(); };

   virtual const DtControlObjectKind& kind() const;
   virtual void setKind(const DtControlObjectKind& k);

   virtual const DtControlObjectCategory& category() const;
   virtual void setCategory(const DtControlObjectCategory& c);

   virtual void generateUniqueId();
   virtual void setUniqueId(const DtVrlUuid& uniqueId);
   virtual const DtVrlUuid& uniqueId() const;

   const std::vector<DtVector>& vertexList() const;

   virtual void updateExtensions();

   virtual int compare(const DtControlObjectBaseRepository* rhs);

   virtual int compareToMostRecent();

   virtual bool locationsDifferent(bool updateIfDifferent);
   virtual void emptyVertexList();

   static void initializePuffFactory();
   static void addToPuffFactory(int iRecordType, DtIttSourceDataCreator fcn);
   static DtIttSourceData* createPuffRecord(DtNetEnvironmentalRecord* geometric,
      DtNetEnvironmentalRecord* source);
   static DtIttSourceData* createPuffRecord(DtNetEnvironmentalRecord* rec);

   virtual void getBoundingVolume(DtVector& location, double& radius) const;

   const DtGeometricDataList& geometricRecords() const;
   bool geometricRecordsChanged() const;
   void clearGeometricRecordsChanged();

   virtual void updateDataRecords();

   virtual int numberOfSubordinates() const;
   virtual bool getSubordinate(int i, DtGlobalObjectDesignator& d);
   virtual const DtGlobalObjectDesignatorList& subordinates() const;
   virtual DtGlobalObjectDesignatorList& subordinates();

   virtual void setExtendedData(const std::map<DtString, DtString> &ed) override;
   virtual void setExtendedData(const DtString &key,
                                const DtString &value) override;

   virtual double orientation() const;

   virtual void setVertices(const DtList& pnt);
   virtual void appendVertex(const DtVector&);
   virtual void setVertex(int i, const DtVector&);
   virtual void removeVertex(int i);


   virtual DtForceType forceType() const;
   virtual void setForceType(DtForceType i);

   virtual int color() const;
   virtual void setColor(int);

   virtual const DtString& parent() const;
   virtual void setParent(const DtString&);

   virtual const DtString& userData() const;
   virtual void setUserData(const DtString&);

   virtual void setVrfObjectName(const DtString&);
   virtual const DtString& vrfObjectName();

   virtual DtAppearance appearance() const;
   virtual void setAppearance(const DtAppearance& app);

   virtual void setNumberOfSubordinates(int);
   virtual void setSubordinate(int i, const DtGlobalObjectDesignator&);

   virtual const DtGlobalObjectDesignator& hostGlobalId() const;
   virtual void setHostGlobalId(const DtGlobalObjectDesignator&);

   virtual void setObjectAttachMode(DtVrfObjectAttachMode);
   virtual DtVrfObjectAttachMode objectAttachMode() const;

   virtual void clearHostGlobalId();

   virtual bool getFontInformation(DtString& font, int& fontSize) const;
   virtual void setFontInformation(const DtString&, int fontSize);

   virtual bool getFontColor(unsigned int& color) const;
   virtual void setFontColor(unsigned int color);

   virtual bool getArrowInformation(int& arrowHeadPlacement, int& arrowStyle, int& arrowSize) const;
   virtual void setArrowInformation(int arrowHeadPlacement, int arrowStyle, int arrowSize);


   virtual void setBoundingSphereRadius(double);
   virtual double boundingSphereRadius() const;

   virtual void setBoundingSphereLocation(const DtVector&);
   virtual const DtVector& boundingSphereLocation() const;

   bool hasBoundingSphereRecord() const;


   bool hasBoundingRectRecord() const;

   virtual void setBoundingExtent(const DtVector&);
   const DtVector& boundingExtent() const;

   virtual void setBoundingCornerLocation(const DtVector&);
   virtual const DtVector& boundingCornerLocation() const;

   virtual void setBoundingOrientation(const DtTaitBryan&);
   const DtTaitBryan& boundingOrientation() const;

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

   virtual void setClosedFigure(bool);
   virtual bool closedFigure() const;

   virtual void setBound2D(bool);
   virtual bool bound2D() const;

   virtual void setFillStyle(int);
   virtual int fillStyle() const;

   virtual void setLineStyle(int);
   virtual int lineStyle() const;

   virtual void setLineWidth(int);
   virtual int lineWidth() const;

   virtual void setPhysicalLineHeight(double);
   virtual double physicalLineHeight() const;

   virtual void setPhysicalLineWidth(double);
   virtual double physicalLineWidth() const;

   virtual void setRelativeLocation(const DtVector&);
   virtual const DtVector& relativeLocation() const;

   virtual void setVelocity(const DtVector&);
   virtual const DtVector& velocity() const;

   virtual void setAcceleration(const DtVector&);
   virtual const DtVector& acceleration() const;

   virtual void setDRAlogrithm(DtDeadReckonTypes);
   virtual const DtDeadReckonTypes& drAlgorithm() const;

   virtual void setOffsetPoints(const std::vector<DtVector>&);
   virtual const std::vector<DtVector>& offsetPoints() const;

   virtual void setCachePoints(bool);
   bool cachePoints() const;

   virtual DtString extendedData(const DtString &key) const override;

   const DtVrfExtendedRecordData& extendedRecordData() const
   {
      return myExtendedRecordData;
   }

   DtVrfExtendedRecordData& extendedRecordData()
   {
      return myExtendedRecordData;
   }

   int numberOfDatumRecords() const;
   void setNumberOfDatumRecords(int);

   virtual void setSendVrfObjectDataRecord(bool shouldSend);
   virtual bool shouldSendVrfObjectDataRecord() const;

protected:

#ifdef DtDIS
   virtual void addUuidRecord();
#endif

   virtual bool createExtendedEnvironmentalStateRecord();

   virtual DtSimEnvironmentalObjectStateRecord* extendedEnvironmentalStateRecord();

   virtual bool createVrfObjectStateRecord();

   virtual DtVrfObjectDataEnvironmentalRecord* vrfObjectStateRecord();

   virtual bool createBoundingSphereRecord();

   virtual DtEnvironmentalBoundingSphereRecord* boundingSphereRecord();

   virtual bool createBoundingRectRecord();

   virtual DtEnvironmentalRectangularVolumeRecord* boundingRectRecord();

   virtual void setupKindFromType(const DtEntityType& type);
   virtual void getBoundingVolume(EnvGeomSpheriod* rec);
   virtual void clearGeometricRecords();

   virtual void extensionModified() override;

public:
   static DtEnvironmentProcessRepository* create();

   DtControlObjectKind myKind;
   DtControlObjectCategory myCategory;

   DtCOVertexList myVertexList;

   DtSimEnvironmentalObjectStateRecord* myExtEnvStateRecord;
   DtEnvironmentalBoundingSphereRecord* myBoundingSphereRecord;
   DtVrfObjectDataEnvironmentalRecord*               myVrfObjectStateRecord;
   DtControlObjectBaseRepository*           myLastCopy;
   DtEnvironmentalRectangularVolumeRecord* myBoundingRectRecord;

   bool myGeneratedUuid;
   DtVrlUuid myUuid;

   static DtIttSourceDataMap thePuffFactory;
   DtGeometricDataList myGeometricRecords;
   bool  myGeometricRecordsChanged;
   bool myNeedVrfObjectDataUpdate;

   bool myCachePoints;
   int  myPointsSet;

   DtEnvironmentalProcessExtendedRecordData myExtendedRecordData;

   bool mySendVrfObjectDataRec;
};

inline const DtControlObjectBaseRepository::DtGeometricDataList& DtControlObjectBaseRepository::geometricRecords() const
{
   return myGeometricRecords;
}

inline bool DtControlObjectBaseRepository::geometricRecordsChanged() const
{
   return myGeometricRecordsChanged;
}

inline void DtControlObjectBaseRepository::clearGeometricRecordsChanged()
{
   myGeometricRecordsChanged = false;
}

inline bool DtControlObjectBaseRepository::hasBoundingSphereRecord() const
{
   return (myBoundingSphereRecord != NULL);
}

inline bool DtControlObjectBaseRepository::hasBoundingRectRecord() const
{
   return (myBoundingRectRecord != NULL);
}

inline bool DtControlObjectBaseRepository::cachePoints() const
{
   return myCachePoints;
}