movingObjectParameters.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfobjparam/vrfObjectParameters.h"
#include "readerWriter/rwVector.h"
#include <readerWriter/readerWriterFile.h>
#include "vrfutil/rwDIGuyCharacterInfo.h"

class DtEnvironment;

class DT_DLL_vrfobjparam DtMovingObjectParameters : public DtVrfObjectParameters
{
public:

   DtMovingObjectParameters(const DtString& name = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = NULL,
      DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
   DtMovingObjectParameters(const DtSymbolString& name,
      DtReaderWriterRegistry* parentRegistry = NULL,
      DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);

   virtual ~DtMovingObjectParameters();

protected:
   DtMovingObjectParameters (const DtMovingObjectParameters& orig,
      const DtString& name = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtMovingObjectParameters (const DtMovingObjectParameters& orig,
      const DtSymbolString& name,
      DtReaderWriterRegistry* parentRegistry = NULL);

public:
   const DtMovingObjectParameters& operator=
      (const DtMovingObjectParameters& orig);

   virtual DtVrfObjectParameters* clone
      (const DtString& name = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = NULL) const;
   virtual DtVrfObjectParameters* clone
      (const DtSymbolString& name,
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual DtString type() const;

   static DtVrfObjectParameters * creator(DtEnvironmentSP env, DtEnvValueSP* objectNode);

   virtual bool inheritValues (const DtVrfObjectParameters* benefactor);
   virtual void inheritValuesFromThisType (
      const DtMovingObjectParameters* benefactor);

private:
   using DtVrfObjectParameters::inheritValuesFromThisType;
public:

   virtual int illuminationRecalcTime() const;
   virtual void setIlluminationRecalcTime(int newValue);

   virtual int weatherAreaRecalcTime() const;
   virtual void setWeatherAreaRecalcTime(int newValue);

   virtual bool canPivot() const;
   virtual void setCanPivot (bool newValue);

   virtual bool protectEmbarkedFromCollateralDamage() const;
   virtual void setProtectEmbarkedFromCollateralDamage (bool newValue);

   virtual DtReal maxPivotSpeed() const;
   virtual void setMaxPivotSpeed (DtReal maxSpeed);

   virtual const DtVector& leftSupport() const;
   virtual void setLeftSupport (const DtVector& newLeftSupport);

   virtual const DtVector& rightSupport() const;
   virtual void setRightSupport (const DtVector& newRightSupport);

   virtual const DtVector& otherSupport() const;
   virtual void setOtherSupport (const DtVector& newOtherSupport);

   virtual DtReal maxSpeed() const;
   virtual void setMaxSpeed (DtReal speed);

   virtual DtReal maxReverseSpeed() const;
   virtual void setMaxReverseSpeed (DtReal speed);

   virtual bool useModelArtPartInformation() const;
   virtual void setUseModelArtPartInformation(bool);

   virtual DtReal turningRadius() const;
   virtual void setTurningRadius (DtReal turningRadius);

   virtual DtReal maxSlope() const;
   virtual void setMaxSlope (DtReal slope);

   virtual DtReal orderedSpeed() const;
   virtual void setOrderedSpeed (DtReal speed);

   virtual DtReal maxAcceleration() const;
   virtual void setMaxAcceleration (const DtReal maxAcceleration);

   virtual DtReal maxStoppingDeceleration() const;
   virtual void setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration);

   virtual DtReal maxLateralAcceleration() const;
   virtual void setMaxLateralAcceleration (const DtReal maxLateralAcceleration);

   virtual DtReal fuelEfficiency() const;
   virtual void setFuelEfficiency (const DtReal efficiency);

   virtual bool useObjectGeometry() const;
   virtual void setUseObjectGeometry(bool);

   virtual bool useObjectVisuals() const;
   virtual void setUseObjectVisuals(bool);

   virtual const DtString& objectGeometryFile() const;
   virtual void setObjectGeometryFile(const DtFilename&);

   virtual bool embedIntoTerrain() const;
   virtual void setEmbedIntoTerrain(bool);

   virtual void setDIGuyCharacterInfo(const DtRwDIGuyCharacterInfo & info);
   virtual  const DtRwDIGuyCharacterInfo & diguyCharacterInfo() const;

   virtual void setUsingRailMovement(bool rails);
   virtual bool usingRailMovement() const;

   virtual void postGetSelf();

protected:


   DtRwBoolean myCanPivot;

   DtRwReal myMaxPivotSpeed;

   DtRwOffsetVector myLeftSupport;

   DtRwOffsetVector myRightSupport;

   DtRwOffsetVector myOtherSupport;

   DtRwReal myMaxSpeed;

   DtRwReal myMaxReverseSpeed;

   DtRwReal myTurningRadius;

   DtRwReal myMaxSlope;

   DtRwReal myOrderedSpeed;

   DtRwReal myMaxAcceleration;

   DtRwReal myMaxStoppingDeceleration;

   DtRwReal myMaxLateralAcceleration;

   DtRwReal myFuelEfficiency;

   DtReaderWriterFile  myObjectGeometryFile;

   DtRwBoolean  myUseObjectGeometry;

   DtRwBoolean  myUseObjectVisuals;

   DtRwBoolean myEmbedIntoTerrain;

   DtRwDIGuyCharacterInfo   myDIGuyCharacterInfo;

   DtRwBoolean myUsingRailMovement;

   DtRwInt myIlluminationRecalcTime;

   DtRwInt myWeatherAreaRecalcTime;

   DtRwBoolean myProtectEmbarkedFromCollateralDamage;

   DtRwBoolean myUseModelArtPartInformation;

};