controlObjectRepository.h

Go to the documentation of this file.

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

#pragma once

#include <vl/environmentProcessRepository.h>
#include <vrfExtObjects/vrfExtensions.h>
#include <vrfExtProtocol/vrfExtendedRecordData.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;

// class DtControlObjectRepository:
//
// Instances of DtControlObjectRepository are
#include <vrfExtObjects/vrfExtObjectsDefines.h>

class DT_DLL_vrfExtObjects DtExtendedEnvironmentalDataRecord : public DtEnvironmentalRecord
{
public:

   // default constructor
   DtExtendedEnvironmentalDataRecord(const char* data, int length);
   DtExtendedEnvironmentalDataRecord();

   DtExtendedEnvironmentalDataRecord(
      const DtExtendedEnvironmentalDataRecord& orig);

   // destructor
   virtual ~DtExtendedEnvironmentalDataRecord();

   DtExtendedEnvironmentalDataRecord& operator=(const DtExtendedEnvironmentalDataRecord& orig);

   // Returns a newly created instance of a DtIfVrfObjectData.
   virtual DtEnvironmentalRecord * clone() const;

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

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

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

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

class DtControlObjectRepository;

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

   virtual ~DtEnvironmentalProcessExtendedRecordData();

   virtual void updateDataRecords(DtControlObjectRepository*);

   virtual void decodeDataRecords(DtControlObjectRepository*);

   virtual bool readFromRecord(const DtNetEnvironmentalRecord*);
};

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

public:

   // default constructor
   DtControlObjectRepository();

   // destructor
   virtual ~DtControlObjectRepository();

   // copy constructor
   DtControlObjectRepository(const DtControlObjectRepository& orig);

   // assignment operator
   DtControlObjectRepository& operator=(const DtControlObjectRepository& orig);

   // Return a copy/empty object of the same type as this.
   virtual DtStateRepository* clone(bool copy = false) const;

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

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

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

   // updateExtensions()
   // extracts the extended environmental process state information,
   // if present, from the state repository
   virtual void updateExtensions();

   // Compares us against the supplied state repository and returns what's 
   // changed. Since this is being called from a location where the vertex list 
   // is already being checked, we don't need to do it.
   virtual int compare(const DtControlObjectRepository* rhs);

   // Returns what has changed since the last time we called compare
   virtual int compareToMostRecent();

   // Returns true if our stashed location is different than our
   // current location
   virtual bool locationsDifferent(bool updateIfDifferent);
   virtual void emptyVertexList();

   // Adds mappings between environmental record types and the
   // type of information to read off of the network into local
   // environmental data structures
   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();

   // If myNeedVrfObjectDataUpdate is true, update the vrf object data record.  Also sets
   // all vrf specific data records into state repository.  Called from publisher
   virtual void updateDataRecords();

   // Subordinate information.  Not currently used by VRF
   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);
   virtual void setExtendedData(const DtString& key, const DtString& value);

   virtual double orientation() const;

public:
   // Sets the vertices to use in the publication of this object.  Will create the environmental records (as needed),
   // put them into the state repository structure and also the vertex list.  This routine assumes the DtList contains DtVectors
   virtual void setVertices(const DtList& pnt);
   virtual void appendVertex(const DtVector&);
   virtual void setVertex(int i, const DtVector&);
   virtual void removeVertex(int i);

public:
   // Environmental record settings

   // Used to set in appearance value of env state record and vrf object data message
   virtual void setObjectType(const DtObjectType&);


   // Returns the force type from the environmental header record (if it exists), else
   // returns neutral by default
   virtual DtForceType forceType() const;
   virtual void setForceType(DtForceType i);

   // Returns the color (rgb) value of this object
   virtual int color() const;
   virtual void setColor(int);

   // Returns the parent of this object
   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&);

   // Returns the parent this object might be attached to
   virtual const DtGlobalObjectDesignator& hostGlobalId() const;
   virtual void setHostGlobalId(const DtGlobalObjectDesignator&);

   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);

public:

   // In setting the bounding sphere radius, if a bounding sphere record does not exist, it
   // will be created
   virtual void setBoundingSphereRadius(double);
   virtual double boundingSphereRadius() const;

   // Sets/gets the bounding sphere location.  Will also create the record on set if it does not
   // exist
   virtual void setBoundingSphereLocation(const DtVector&);
   virtual const DtVector& boundingSphereLocation() const;

   bool hasBoundingSphereRecord() const;

public:

   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;

public:
   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;

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

   virtual DtString extendedData(const DtString& key) const;

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

   DtVrfExtendedRecordData& extendedRecordData()
   {
      return myExtendedRecordData;
   }

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

protected:
   // createExtendedEnvironmentalStateRecord()
   // allocates myExtEnvStateRecord, a DtSimEnvironmentalObjectStateRecord
   // used by VR-Forces as extended environmental process state information:
   virtual bool createExtendedEnvironmentalStateRecord();

   // extendedEnvironmentalStateRecord()
   // returns the myExtEnvStateRecord for inspection by
   // the caller.  If myExtEnvStateRecord is NULL, it is created.
   virtual DtSimEnvironmentalObjectStateRecord* extendedEnvironmentalStateRecord();

   // createVrfObjectStateRecord()
   // allocates myVrfObjectStateRecord, a DtVrfObjectDataEnvironmentalRecord
   // used by VR-Forces as extended vrf object state information:
   virtual bool createVrfObjectStateRecord();

   // extendedVrfObjectStateRecord()
   // returns the myVrfObjectStateRecord for inspection by
   // the caller.  If myVrfObjectStateRecord is NULL, it is created.
   virtual DtVrfObjectDataEnvironmentalRecord* vrfObjectStateRecord();

   // createBoundingSphereRecord()
   // allocates myBoundingSphereRecord
   virtual bool createBoundingSphereRecord();

   // boundingSphereRecord()
   // returns the myBoundingSphereRecord for inspection by
   // the caller.  If myBoundingSphereRecord is NULL, it is created.
   virtual DtEnvironmentalBoundingSphereRecord* boundingSphereRecord();

   // createBoundingRectRecord()
   // allocates myBoundingRectRecord
   virtual bool createBoundingRectRecord();

   // boundingRectRecord()
   // returns the myBoundingRectRecord for inspection by
   // the caller.  If myBoundingRectRecord is NULL, it is created.
   virtual DtEnvironmentalRectangularVolumeRecord* boundingRectRecord();

protected:
   // Sets up internal object kind and category from object type
   virtual void setupKindFromType(const DtEntityType& type);
   virtual void getBoundingVolume(EnvGeomSpheriod* rec);
   virtual void clearGeometricRecords();

protected:
   // Override to set myNeedVrfObjectDataUpdate to true
   virtual void extensionModified();

public:
   static DtEnvironmentProcessRepository* create();

   DtControlObjectKind myKind;
   DtControlObjectCategory myCategory;

   // Keeps a list of all geometry point records to use to update internal
   // model datas from
   DtCOVertexList myVertexList;

   // DtSimEnvironmentalObjectStateRecord is a special form
   // of DtEnvironmentalRecord, used to decode custom data
   // that might be published from a VR-Forces back end, such
   // as label, force type, appearance, etc.
   // see "envObjState.h"
   DtSimEnvironmentalObjectStateRecord* myExtEnvStateRecord;
   DtEnvironmentalBoundingSphereRecord* myBoundingSphereRecord;
   DtVrfObjectDataEnvironmentalRecord*               myVrfObjectStateRecord;
   DtControlObjectRepository*           myLastCopy;
   DtEnvironmentalRectangularVolumeRecord* myBoundingRectRecord;

   // This information is needed for ITT puff clouds
   static DtIttSourceDataMap thePuffFactory;
   DtGeometricDataList myGeometricRecords;
   bool  myGeometricRecordsChanged;
   bool myNeedVrfObjectDataUpdate;

   bool myCachePoints;
   int  myPointsSet;

   DtEnvironmentalProcessExtendedRecordData myExtendedRecordData;
};

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

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

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

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

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

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