simEnvironmentalObjectStateRecord.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2017 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vlpi/entityType.h>
#include <vl/globalObjectDesignatorList.h>
#include <vl/environmentalRecord.h>
#include <vlpi/appearance.h>
#include <vlpi/disEnums.h>

#define DtLineWidthFromAppearance(theAppr) ((theAppr >> 28) & 0x0000000F)
#define DtLineWidthToAppearance(theLineWidth) (theLineWidth << 28)
#define DtLineStyleFromAppearance(theAppr) ((theAppr >> 8) & 0x0000000F)
#define DtLineStyleToAppearance(theLineStyle) (theLineStyle << 8)
#define DtFillStyleFromAppearance(theAppr) ((theAppr >> 12) & 0x0000000F)
#define DtFillStyleToAppearance(theFillStyle) (theFillStyle << 12)

// Definition of the FIXED PORTION of the environmental state object.
// This will be followed by a variable length string of bytes to represent
// the object label, and 0 or more global object designators to represent
// any subordinate objects within the object represented.

// If this structure is of a previous type, use that structure instead
struct DtNetEnvironmentalObjectStateRecord_V1
{
   DtNetEnvironmentalRecord myHeader;
   DtNetU32                 myAppearance;
   DtNetU8                  myForceType;
   DtNetU8                  myLabelSize;
   DtNetU16                 myNumberOfSubordinates;
};

struct DtNetEnvironmentalObjectStateRecord_V2
{
   DtNetEnvironmentalRecord myHeader;
   DtNetU32                 myAppearance;
   DtNetU8                  myForceType;
   DtNetU8                  myLabelSize;
   DtNetU16                 myNumberOfSubordinates;
   DtNetU32                 myColor;
   DtNetU8                  myParentSize;
};

struct DtNetEnvironmentalObjectStateRecord_V3
{
   DtNetEnvironmentalRecord      myHeader;
   DtNetU32                      myAppearance;
   DtNetU8                       myForceType;
   DtNetU8                       myLabelSize;
   DtNetU16                      myNumberOfSubordinates;
   DtNetU32                      myColor;
   DtNetU8                       myParentSize;
   DtNetGlobalObjectDesignator   myHostGlobalId;
};

struct DtNetEnvironmentalObjectStateRecord_V4
{
   DtNetEnvironmentalRecord      myHeader;
   DtNetU32                      myAppearance;
   DtNetU8                       myForceType;
   DtNetU8                       myLabelSize;
   DtNetU16                      myNumberOfSubordinates;
   DtNetU32                      myColor;
   DtNetU8                       myParentSize;
   DtNetGlobalObjectDesignator   myHostGlobalId;
   DtNetU8                       myUserDataSize;
};

struct DtNetEnvironmentalObjectStateRecord_V5
{
   DtNetEnvironmentalRecord      myHeader;
   DtNetU32                      myAppearance;
   DtNetU8                       myForceType;
   DtNetU8                       myLabelSize;
   DtNetU16                      myNumberOfSubordinates;
   DtNetU32                      myColor;
   DtNetU8                       myParentSize;
   DtNetGlobalObjectDesignator   myHostGlobalId;
   DtNetU16                       myUserDataSize;
};

struct DtNetEnvironmentalObjectStateRecord_V6
{
   DtNetEnvironmentalRecord      myHeader;
   DtNetU32                      myAppearance;
   DtNetU8                       myForceType;
   DtNetU8                       myLabelSize;
   DtNetU16                      myNumberOfSubordinates;
   DtNetU32                      myColor;
   DtNetU8                       myParentSize;
   DtNetGlobalObjectDesignator   myHostGlobalId;
   DtNetU16                       myUserDataSize;
   DtNetFloat32                  myPhysicalLineHeight;
   DtNetFloat32                  myPhysicalLineWidth;
   DtNetU32                      myVersion;

   DtNetVector64                 myRelativeLocation;

   DtNetVector64                 myVelocity;
   DtNetVector64                 myAcceleration;
   DtNetU8                       myDRAlgorithm;

   DtNetU32                      myOffsetPoints;

};

struct DtNetEnvironmentalObjectStateRecord : public DtNetEnvironmentalObjectStateRecord_V6
{
   DtNetU32 myObjectAttachMode; //  See vrfObjectAttachEnums.h -- default EntityOrientation
};


const int DtMaxEnvProcessLabelLength = 255;

const int DtEnvironmentalRecordVersion = 2;

// Class Description: DtEnvironmentalStateRecord implements a form of an
// environmental state record not explicitly defined in the standard, but
// used in MaK applications.  It contains a DtForceType to identify the force
// with which the environmental object is associated (may be DtForceOther) and
// an entity state-like appearance vector (using DtAppearance).
class DT_DLL_vrfExtObjects DtSimEnvironmentalObjectStateRecord : public DtEnvironmentalRecord
{
public:
   // Default Constructor.  To function properly, the state record should be
   // initialized with an entity type.
   DtSimEnvironmentalObjectStateRecord();

   // Constructor
   DtSimEnvironmentalObjectStateRecord(const DtEntityType& entType);

   DtSimEnvironmentalObjectStateRecord(
      const DtSimEnvironmentalObjectStateRecord& orig);

   // Assignment Operator
   const DtSimEnvironmentalObjectStateRecord& operator=(
      const DtSimEnvironmentalObjectStateRecord& orig);

   // Destructor
   virtual ~DtSimEnvironmentalObjectStateRecord();

   // Clone.  Return a copy of this instance.
   virtual DtEnvironmentalRecord* clone() const;

   // Appearance of the object.
   virtual void setAppearance(const DtAppearance& appearance);
   virtual const DtAppearance& appearance() const;

   // Force the object is associated with.
   virtual void setForceType(DtForceType forceType);
   virtual DtForceType forceType() const;

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

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

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

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

   virtual bool setNumberOfSubordinates(int newNumberOfSubordinates);
   virtual int numberOfSubordinates() const;

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

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

   virtual const DtGlobalObjectDesignatorList& subordinates() const;
   virtual DtGlobalObjectDesignatorList& subordinates();

   // This doesn't need to be called explicitly.  If any routine that needs
   // the repository finds that it hasn't been created yet, it calls this
   // method.
   virtual bool createNetworkRepresentation();

   // returns the network representation of the environmental record
   const DtNetEnvironmentalObjectStateRecord* objStateNetRep() const;
   DtNetEnvironmentalObjectStateRecord* objStateNetRep();

   // used by the PDU class to fill in the network representation
   virtual void setFromNet(const DtNetEnvironmentalRecord& buffer, int protocolVersion);

   virtual int netRepSize() const;

   // If object is attached, this is the id of the parent
   virtual void setHostGlobalId(const DtGlobalObjectDesignator&);
   virtual const DtGlobalObjectDesignator& hostGlobalId() const;

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

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

   // Clears out the host global id (sets it to "")
   virtual void clearHostGlobalId();

   // Get/set projected, close and bound2d as in bit pattern above
   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 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;

protected:

   virtual bool resizeNetRep(int newSize);

   // These two 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* pointerToLabel() const;
   virtual void* pointerToParent() const;
   virtual void* pointerToSubordinates() const;
   virtual void* pointerToUserData() const;
   virtual void* pointerToOffsetPoints() const;

   // Casts the 'this' pointer for changing elements in a const function.
   DtSimEnvironmentalObjectStateRecord* self() const;

   // Reworks the network buffer based on record version (type)
   virtual void reworkStateRepForVersion(int bytesToCopy, int iVersion);

   // Reworks the network buffer based on version in record.  This started with _V6, xo, the size must be at least that
   virtual void reworkStateRepForVersionedRecord(int bytesToCopy);

protected:

   DtGlobalObjectDesignatorList mySubordinates;
   DtAppearance myAppearance;
   DtString myLabel;
   DtString myParent;
   int myColor;
   DtForceType myForceType;
   DtGlobalObjectDesignator   myHostGlobalId;
   DtString myUserData;
   int myVersion;
   double myPhysicalLineHeight;
   double myPhysicalLineWidth;
   int myNetRepSize;
   DtVector myRelativeLocation;
   std::vector<DtVector> myOffsetPoints;
   DtVector myVelocity;
   DtVector myAcceleration;
   DtDeadReckonTypes myDRAlgorithm;
   int myObjectAttachMode;
};