physicalWorldParams.h

Go to the documentation of this file.

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



#pragma once

#include <readerWriter/readerWriter.h>
#include "vrfobjparam/signaturePropagatorDescriptorList.h"
#include "vrfutil/rwNLengthStringVector.h"
#include <readerWriter/rwBoolean.h>
#include "vrfutil/rwEntityTypeList.h"
#include <readerWriter/rwReal.h>
#include "vrfobjparam/illuminationObjectParameters.h"
#include "vrfobjparam/vrfobjparamDefines.h"

class DtReaderWriterRegistry;

class DT_DLL_vrfobjparam DtPhysicalWorldParams : public DtReaderWriter
{
public:
   enum MergeFlags
   {
      LineOfSiteTests = 0x00000001,
      SignaturePropagatorParams = 0x00000002,
      IlluminationObjects = 0x00000004,
      SpatialOrganizationObjectTypes = 0x00000008,
      DefaultMerge = SignaturePropagatorParams | IlluminationObjects |SpatialOrganizationObjectTypes
   };

    DtPhysicalWorldParams(const DtString& rwName, 
      DtReaderWriterRegistry* parentRegistry = NULL);
    DtPhysicalWorldParams(const DtSymbolString& rwName, 
      DtReaderWriterRegistry* parentRegistry = NULL);

    DtPhysicalWorldParams(const DtPhysicalWorldParams& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtPhysicalWorldParams& operator=(const DtPhysicalWorldParams& orig);

   virtual ~DtPhysicalWorldParams() override;

   virtual DtlObjPtr getData(
      DtlObjPtr args, const SearchPaths& searchPaths, const DtVariableBindingsList& variableBindings) override;

   virtual DtSignaturePropagatorDescriptorList& signaturePropagatorParams();
   virtual const DtSignaturePropagatorDescriptorList& signaturePropagatorParams() const;

   virtual DtRwNLengthStringVector& lineOfSightTests();
   virtual const DtRwNLengthStringVector& lineOfSightTests() const;

   virtual bool extrudeVectorObstructions() const;
   virtual void setExtrudeVectorObstructions(bool extrude);


   virtual DtRwEntityTypeList& spatialOrganizationObjectTypes();
   virtual const DtRwEntityTypeList& spatialOrganizationObjectTypes() const;


   virtual double terrainPreloadLookaheadTime() const;
   virtual void setTerrainPreloadLookaheadTime(double v);


   virtual double terrainPreloadPeriod() const;
   virtual void setTerrainPreloadPeriod(double seconds);


   virtual double terrainPreloadExpireTime() const;
   virtual void setTerrainPreloadExpireTime(double seconds);


   virtual double terrainIntersectExpireTime() const;
   virtual void setTerrainIntersectExpireTime(double seconds);


   virtual double featureLOSPredictionTime() const;
   virtual void setFeatureLOSPredictionTime(double seconds);


   virtual double featureLOSCheckDistance() const;
   virtual void setFeatureLOSCheckDistance(double meters);


   virtual double minimalIlluminationValue() const;
   virtual void setMinimalIlluminationValue(double);


   virtual double nighttimeIlluminationValue() const;
   virtual void setNighttimeIlluminationValue(double);

   virtual DtIlluminationObjectParametersList& illuminationObjects();
   virtual const DtIlluminationObjectParametersList& illuminationObjects() const;

   virtual DtRwString weatherStateProviderName() const;
   virtual void setWeatherStateProviderName(const DtRwString&);
   

   virtual DtRwString deepWaterSoilName() const;
   virtual void setDeepWaterSoilName(const DtRwString&);

   virtual DtRwString shallowWaterSoilName() const;
   virtual void setShallowWaterSoilName(const DtRwString&);

   virtual DtRwString waterySoilName() const;
   virtual void setWaterySoilName(const DtRwString&);

   virtual DtRwString drySoilName() const;
   virtual void setDrySoilName(const DtRwString&);

   virtual DtRwString roadSoilName() const;
   virtual void setRoadSoilName(const DtRwString&);

   virtual DtRwString snowSoilName() const;
   virtual void setSnowSoilName(const DtRwString&);

   virtual DtRwString iceSoilName() const;
   virtual void setIceSoilName(const DtRwString&);

   virtual double deepSnowDepth() const;
   virtual void setDeepSnowDepth(const double);

   virtual double saturationWaterDepth() const;
   virtual void setSaturationWaterDepth(const double);

   virtual double waterSlideDepth() const;
   virtual void setWaterSlideDepth(const double);

   virtual double waterSlideFactor() const;
   virtual void setWaterSlideFactor(const double);

   virtual double hardFreezeTemperature() const;
   virtual void setHardFreezeTemperature(const double);

   virtual double normalizedPrecipitationRate() const;
   virtual void setNormalizedPrecipitationRate(const double);

   virtual bool reduceVisibilityForPrecipitation() const;
   virtual void setReduceVisibilityForPrecipitation(const bool);


   virtual DtRwEntityTypeList& entityTypesIgnoredForLos();
   virtual const DtRwEntityTypeList& entityTypesIgnoredForLos() const;


   virtual void merge(const DtPhysicalWorldParams*, MergeFlags merge = DefaultMerge);


   virtual void mergeLineOfSightTests(const DtPhysicalWorldParams*);
   virtual void addTest(const DtString& test);


   virtual void mergeSignaturePropagatorParams(const DtPhysicalWorldParams*);


   virtual void mergeSpatialOrganizationObjectTypes(const DtPhysicalWorldParams*);

   virtual void mergeIlluminationObjects(const DtPhysicalWorldParams* l);

   virtual void mergeEntityTypesIgnoredForLos(const DtPhysicalWorldParams* otherParams);

private:
   DtPhysicalWorldParams();

protected:
   DtSignaturePropagatorDescriptorList mySignaturePropagatorParams;

   DtRwNLengthStringVector myLineOfSightTests;

   DtRwBoolean myExtrudeVectorObstructions;

   DtRwEntityTypeList mySpatialOrganizationObjectTypes;

   DtRwReal myTerrainPreloadLookaheadTime;

   DtRwReal myTerrainPreloadPeriod;

   DtRwReal myTerrainPreloadExpireTime;

   DtRwReal myTerrainIntersectExpireTime;

   DtRwReal myFeatureLOSPredictionTime;

   DtRwReal myFeatureLOSCheckDistance;

   DtRwReal myMinimalIlluminationValue;

   DtRwReal myNighttimeIlluminationValue;

   DtIlluminationObjectParametersList myIlluminationObjects;

   DtRwString myWeatherStateProviderName;

   DtRwString myDeepWaterSoilName;

   DtRwString myShallowWaterSoilName;

   DtRwString myWaterySoilName;

   DtRwString myDrySoilName;

   DtRwString myRoadSoilName;

   DtRwString mySnowSoilName;

   DtRwString myIceSoilName;

   DtRwReal myDeepSnowDepth;

   DtRwReal mySaturationWaterDepth;

   DtRwReal myWaterSlideDepth;

   DtRwReal myWaterSlideFactor;

   DtRwReal myHardFreezeTemperature;

   DtRwReal myNormalizedPrecipitationRate;

   DtRwBoolean myReduceVisibilityForPrecipitation;

   DtRwEntityTypeList myEntityTypesIgnoredForLos;
};