railMovementDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/componentDescriptor.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwObjectType.h"
#include "vrfutil/rwObjectTypeList.h"
#include "vrfutil/rwUnsigned.h"

class DtReaderWriterRegistry;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtRailMovementDescriptor : public DtComponentDescriptor
{
public:
   DtRailMovementDescriptor(const DtString& name, DtReaderWriterRegistry *
      parentRegistry = 0);
   
   DtRailMovementDescriptor(const DtRailMovementDescriptor & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);
   
   DtRailMovementDescriptor & operator=(const 
      DtRailMovementDescriptor & orig);
   
   virtual ~DtRailMovementDescriptor();

   virtual DtString type() const;

   virtual void setUseTurnSmoothing(bool smooth);
   virtual bool useTurnSmoothing() const;

   virtual void setUseAcceleration(bool acc);
   virtual bool useAcceleration() const;

   virtual void setTurnSpeed(double speed);
   virtual const double turnSpeed() const;

   virtual void setAllowToPass(bool pass);
   virtual bool allowToPass() const;

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

   virtual bool drawDebugTurnSplinePoints() const;
   virtual void setDrawDebugTurnSplinePoints(bool draw);

   virtual const double maxFollowThreshold() const;
   virtual void setMaxFollowThreshold(const double threshold);

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

   virtual const double lookAheadDistance() const;
   virtual void setLookAheadDistance(const double distance);

   virtual const double hitTimeLaneChange() const;
   virtual void setHitTimeLaneChange(const double time);

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

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

   virtual void setDrivingLane(unsigned);
   virtual unsigned drivingLane() const;

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

   static DtComponentDescriptor * creator();

protected:
   DtRailMovementDescriptor();

protected:


   DtRwBoolean myUseTurnSmoothing;

   DtRwBoolean myUseAcceleration;

   DtRwReal myTurnSpeed;

   DtRwBoolean myAllowPass;

   DtRwBoolean myUseHighFidelityGroundClamping;

   DtRwBoolean myDrawDebugSplineRoute;

   DtRwReal    myMaxFollowThreshold;

   DtRwReal    myConvoySpeedFactor;

   DtRwReal    myLookAheadDistance;

   DtRwReal    myHitTimeLaneChange;

   DtRwObjectTypeList myPassableObjectTypes;

   DtRwUnsigned myExtraLanes;

   DtRwUnsigned myDrivingLane;

};