surfaceEntityActuatorDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/actuatorComponentDescriptor.h"
#include <vrfutil/rwEntityType.h>
#include <vrfutil/rwResource.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtSurfaceEntityActuatorDescriptor : public DtActuatorComponentDescriptor
{
public:

   static DtComponentDescriptor * creator();

   DtSurfaceEntityActuatorDescriptor
      (const DtString& name,
       DtReaderWriterRegistry * parentRegistry = 0);

   DtSurfaceEntityActuatorDescriptor
      (const DtSurfaceEntityActuatorDescriptor & orig,
       DtReaderWriterRegistry * parentRegistry = 0);

   const DtSurfaceEntityActuatorDescriptor & operator=
      (const DtSurfaceEntityActuatorDescriptor & orig);

   virtual ~DtSurfaceEntityActuatorDescriptor() override;

   virtual DtString type() const override;

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

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

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

   virtual DtReal maxYawRate() const;
   virtual void setMaxYawRate (DtReal maxYawRate);

   virtual DtReal maxYawAcceleration() const;
   virtual void setMaxYawAcceleration(DtReal maxYawAcceleration);

   virtual bool checkSoilType() const;
   virtual void setCheckSoilType(bool check);

   virtual double stoppingSpeed() const;
   virtual void setStoppingSpeed(DtReal stoppingSpeed);

   virtual double turnRollRate() const;
   virtual void setTurnRollRate(DtReal rollRate);

   virtual double speedPitchRate() const;
   virtual void setSpeedPitchRate(DtReal pitchRate);

   virtual double sinkingTime() const;
   virtual void setSinkingTime(DtReal sinkingTime);

   virtual bool surfaceClampClutterEntities() const;
   virtual void setSurfaceClampClutterEntities(bool clamp);

protected:
   DtSurfaceEntityActuatorDescriptor();

protected:


   DtRwReal myMaxYawAcceleration;

   DtRwReal myMaxYawRate;

   DtRwBoolean myCheckSoilType;

   DtRwBoolean mySurfaceClampClutterEntities;

   DtRwReal myStoppingSpeed;

   DtRwReal myTurnRollRate;

   DtRwReal mySpeedPitchRate;

   DtRwReal mySinkingTime;

   DtRwResource myFuelType;

   DtRwReal myFuelEfficiency;
};