groundFollowEntityController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfmodel/groundMoveToDestinationControllerComponent.h"

#include <vlutil/vlString.h>
#include <matrix/vlVector.h>
#include <vlpi/trigonometricSmoother.h>

class DtSimManager;
class DtSimMessage;
class DtStringOutputPort;
class DtGroundFollowEntityDescriptor;

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtGroundFollowEntityController : public DtGroundMoveToDestinationControllerComponent
{

public:

   DtGroundFollowEntityController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtGroundFollowEntityController();

   virtual const char* type() const;


   static void followEntityCallback(DtSimMessage* msg, void* usrData);

   virtual void processFollowEntityTask(DtSimMessage* msg);

   virtual DtVector predictedDestination();

   virtual const DtUUID& entityToFollow();
   virtual void setEntityToFollow(const DtUUID& entity);

   virtual const DtVector& offsetVector() const;
   virtual void setOffsetVector(const DtVector& offsets);

   static DtSimComponent * creator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual void registerTaskMsgCallbacks();

   virtual bool setupDestination();

   virtual bool passedDestination();

   virtual double findDesiredSpeed();

   virtual double findDesiredHeading();
   
   virtual void setupDestinationVector() const;

   virtual DtAutoTransmissionGear determineGearSetting();
  
   virtual void stop();
   
   virtual void tick();

   virtual bool usingNavBot(){return false;}

   virtual void updateNavBotDestination();

   virtual bool needToUpdateNavInterfaceDestination(const DtVector& newLocalDestination);

protected:
   DtGroundFollowEntityController();

   DtGroundFollowEntityController(const DtGroundFollowEntityController & 
      orig);

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

   virtual bool createPorts();

   static void objectAboutToBeRemovedCallback(const DtVrfObject*, void* usr);
   virtual void processObjectAboutToBeRemoved(const DtVrfObject*);

protected:

   DtGroundFollowEntityDescriptor* myComponentDescriptor;

   const DtVrfObject* myLeaderPointer;

   DtStringOutputPort* myFollowEntityOutputPort;

   DtTrigonometricSmoother* myLeaderSmoother;

   DtVector myPredictedDestination;

   double myNavInterfaceDestinationSetTime;
   
   DtVector myNavInterfaceCurrentDestination;

   bool myWarnedOnceDestroyed;
   bool myRemoveCallbackAssigned;
};