terrainIntersectOptions.h

Go to the documentation of this file.

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


#pragma once

#include "terrainInterface/terrainInterfaceDefines.h"
#include <geometry/intersectionRecord.h>
#include "vrfutil/rwTerrainCategoryMask.h"

class DT_DLL_terrainInterface DtTerrainIntersectOptions
{
public:
   DtTerrainIntersectOptions();

   DtTerrainIntersectOptions(bool* dataAvailable, bool overrideAssert, int flags);

   DtTerrainIntersectOptions(DtTerrainCategoryMask terrainCategoryMask, DtIntersectionRecord::DtIntersectionType irtFlag, bool blocking);

   virtual DtIntersectionRecord::DtIntersectionType irtFlag() const;
   virtual void setIrtFlag(DtIntersectionRecord::DtIntersectionType irt);
   
   DtTerrainIntersectOptions withIrt(DtIntersectionRecord::DtIntersectionType irt) const;
   
   DtTerrainIntersectOptions withMask(DtTerrainCategoryMask mask) const;

   virtual DtTerrainCategoryMask terrainCategoryMask() const;
   virtual void setTerrainCategoryMask(DtTerrainCategoryMask mask);

   virtual bool blockOnDataUnavailable() const;

   virtual void setBlockOnDataUnavailable(bool block = true);

   virtual bool overrideBlockingAssert() const;

   virtual void setOverrideBlockingAssert(bool overrideAssert = true);

   virtual int flags() const;

   virtual void setFlags(int f);

   enum Fidelity
   {
      MAX_FIDELITY,
      LOW_FIDELITY
   };

   virtual Fidelity fidelity() const;

   virtual void setFidelity(Fidelity f);

   virtual bool debug() const;
   virtual void setDebug(bool d);
   

   static const DtTerrainIntersectOptions& nonBlocking();
   static const DtTerrainIntersectOptions& allData_nonBlocking();
   static const DtTerrainIntersectOptions& terrainSkin_nonBlocking();
   static const DtTerrainIntersectOptions& noVegetation_nonBlocking();
   static const DtTerrainIntersectOptions& noVegetationAndStructures_nonBlocking();

   static const DtTerrainIntersectOptions& blocking();
   static const DtTerrainIntersectOptions& allData_blocking();
   static const DtTerrainIntersectOptions& terrainSkin_blocking();
   static const DtTerrainIntersectOptions& noVegetation_blocking();
   static const DtTerrainIntersectOptions& noVegetationAndStructures_blocking();


protected:
   DtIntersectionRecord::DtIntersectionType myIrtFlag;
   DtTerrainCategoryMask myTerrainCategoryMask;
   bool myBlockOnDataUnavailable;
   bool myOverrideBlockingAssert;
   int myFlags;
   Fidelity myFidelity;
   bool myDebug;
};