roadMovementDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfobjparam/componentDescriptor.h"
#include <readerWriter/rwBoolean.h>
#include <vrfutil/rwEntityType.h>
#include "vrfutil/rwEntityTypeList.h"
#include "vrfutil/rwUnsigned.h"
#include "vrfutil/rwResource.h"

class DtReaderWriterRegistry;

class DT_DLL_vrfobjparam DtRoadMovementDescriptor : public DtComponentDescriptor
{
public:
   DtRoadMovementDescriptor(const DtString& name, DtReaderWriterRegistry *
      parentRegistry = 0);
   
   DtRoadMovementDescriptor(const DtRoadMovementDescriptor & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   DtRoadMovementDescriptor & operator=(const 
      DtRoadMovementDescriptor & orig);
   
   virtual ~DtRoadMovementDescriptor() override;

   virtual DtString type() const override;

   virtual bool useGroundClamping() const;
   virtual void setUseGroundCamping(bool doUse);

   virtual const DtEntityType& fuelType() const;
   virtual void setFuelType(const DtEntityType& fuelType);

   virtual double fuelEfficiency() const;
   virtual void setFuelEfficiency(double d);

   virtual bool useHighFidelityGroundClamping() const;
   virtual void setUseHighFidelityGroundClamping(bool yesOrNo);

   virtual const double convoyFollowSpeedFactor() const;
   virtual void setConvoyFollowSpeedFactor(const double factor);

   virtual void setPassableObjectTypes(const DtRwEntityTypeList& objectTypes);
   virtual DtRwEntityTypeList& passableObjectTypes();
   virtual const DtRwEntityTypeList& passableObjectTypes() const;

   virtual void setExtraLanesEachDirection(unsigned);
   virtual unsigned extraLanesEachDirection() const;

   virtual void setAddBreakdownLanes(bool);
   virtual bool addBreakdownLanes() const;

   virtual DtComponentDescriptor * clone(DtReaderWriterRegistry* parentRegistry = 0) const override;

   static DtComponentDescriptor * creator();

protected:
   DtRoadMovementDescriptor();

protected:


   DtRwBoolean myClampToGround;

   DtRwBoolean myUseHighFidelityGroundClamping;

   DtRwReal    myConvoySpeedFactor;

   DtRwEntityTypeList myPassableObjectTypes;

   DtRwUnsigned myExtraLanes;

   DtRwBoolean myAddBreakdownLanes;

   DtRwResource myFuelType;

   DtRwReal myFuelEfficiency;
};