terrainCraterGeometry.h

Go to the documentation of this file.

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


#pragma once

#include <vrfExtProtocol/vrfExtProtocolDefines.h>
#include <vrfExtProtocol/terrainGeometry.h>
#include <vlpi/entityType.h>
#include <vlpi/entityIdentifier.h>
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlString.h>
#include <matrix/vlVector.h>
#include <vector>

enum DtTerrainCraterEffectEnum32
{
   DtTerrainCraterNoEffect = 0,
   DtTerrainCraterElevationEffect = 1,
   DtTerrainCraterSoilEffect = 2,
   DtTerrainCraterElevAndSoilEffect = 3,
   DtTerrainCraterAerodromeEffect = 4,
   DtMaxDtTerrainCraterEffectEnum32
};

class DT_DLL_vrfExtProtocol DtTerrainCraterGeometry : public DtTerrainGeometry
{
public:
   DtTerrainCraterGeometry();
   DtTerrainCraterGeometry(const DtVector64& loc, const DtFloat64& radius);
   DtTerrainCraterGeometry(const DtVector64 &loc, const DtFloat64 &majorAxis,
                           const DtFloat64 &minorAxis);
   virtual ~DtTerrainCraterGeometry() override;
   DtTerrainCraterGeometry(const DtTerrainCraterGeometry& orig);
   DtTerrainCraterGeometry& operator=(const DtTerrainCraterGeometry& orig);

   virtual void setLocation(const DtVector64& val);
   virtual const DtVector64& location() const;
   virtual void setMinorAxis(const DtFloat64& val);
   virtual const DtFloat64& minorAxis() const;
   virtual void setMajorAxis(const DtFloat64& val);
   virtual const DtFloat64& majorAxis() const;
   virtual void setHeading(const DtFloat64& val);
   virtual const DtFloat64& heading() const;
   virtual void setDepth(const DtFloat64 &val);
   virtual const DtFloat64& depth() const;
   virtual void setCraterEffectEnum(const DtInt32& val);
   virtual const DtInt32& craterEffectEnum() const;
   virtual void setCraterImageEnum(const DtInt32& val);
   virtual const DtInt32& craterImageEnum() const;
   virtual void setSoilType(const DtInt32& val);
   virtual const DtInt32& soilType() const;

   bool operator==(const DtTerrainCraterGeometry& rhs) const;
   bool operator!=(const DtTerrainCraterGeometry& rhs) const;

   virtual bool approximatelyEqual(const DtTerrainGeometry &other,
                                   double tolerance = -1.0) const override;

   virtual DtTerrainAreaTypeEnum32 terrainAreaType() const override { return theTerrainAreaType(); };

   virtual DtTerrainGeometry *clone() const override;

   virtual int variantNetSize() const override;

   virtual int variantOctetBoundary() const override { return theVariantOctetBoundary(); };

   virtual void writeVariantToBuffer(char *buffer) const override;

   virtual void fillVariantFromBuffer(const char *buffer, int bufferSize,
                                      int offset) override;

   virtual void printData() const override;
   virtual void printDataToStream(std::ostream &) const override;

   static int theVariantOctetBoundary();

   static DtTerrainAreaTypeEnum32 theTerrainAreaType();

protected:
   DtVector64 myLocation;
   DtFloat64 myMajorAxis;
   DtFloat64 myMinorAxis;
   DtFloat64 myHeading;
   DtFloat64 myDepth;
   DtInt32 myCraterEffectEnum;
   DtInt32 myCraterImageEnum;
   DtInt32 mySoilType;
};

DT_DLL_vrfExtProtocol std::ostream& operator<<(std::ostream& stream, const DtTerrainCraterGeometry&);

typedef DtTerrainGeometryVariantInfoTemplate<DtTerrainCraterGeometry> DtTerrainCraterGeometryInfo;