embarkationController.h

Go to the documentation of this file.

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

#pragma once

#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfobjcore/vrfEmbarkationPSR.h"
#include "vrfobjcore/movementLocalObjectFacade.h"




class DtString;
class DtSimulationServices;
class DtTaskMessage;
class DtEmbarkationDescriptor;
class DtIfEmbarkationInformation;
class DtSetDataRequest;
class DtStringOutputPort;

#include <list>

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtEmbarkationController : public DtSingleTaskControllerComponent
{
public:

   DtEmbarkationController(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtEmbarkationController() override;

   virtual bool init() override;

   virtual const char* type() const override;

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

protected:

   virtual bool createPorts() override;

   virtual void registerTaskMsgCallbacks() override;

   virtual void unregisterTaskMsgCallbacks();

   virtual void preFirstTickInit() override;

   virtual void tick() override;

   virtual void clearCurrentTaskMessage() override;

   virtual void suspendTask() override;

   virtual void clearTask() override;

protected:
   virtual void processDisembarkTask(DtSimMessage* msg);
   static void disembarkTaskCallback(DtSimMessage* msg, void* usr);

   virtual void checkAndSetEgressPosture();

   virtual void processEmbarkTask(DtSimMessage* msg);
   static void embarkTaskCallback(DtSimMessage* msg, void* usr);

   static void embarkObjectCallback(DtSimMessage* msg, void* usr);
   virtual void processEmbarkObjectCallback(DtSimMessage* msg);

   static void disembarkObjectCallback(DtSimMessage* msg, void* usr);
   virtual void processDisembarkObjectCallback(DtSimMessage* msg);

   static void embarkationInformationCallback(DtSimMessage* msg, void* usr);
   virtual void processEmbarkationInformationCallback(DtSimMessage* msg);

protected:
   virtual void unableToCompleteTask();

   virtual void processLoadEntity(DtSimMessage * msg);
   virtual void processUnloadEntity(DtSimMessage * msg);

   static void setLoadEntityCallback(DtSimMessage * msg, void * usrData);
   static void setUnloadEntityCallback(DtSimMessage * msg, void * usrData);

   static void setEmbarkationLockedCallback(DtSimMessage * msg, void * usrData);
   virtual void processEmbarkationLocked(DtSimMessage * msg);

   virtual void unload(const DtVector& point, int appearance = 0xFFFFFFFF);

   static void deleteVrfObjectCallback(const DtLocalObject* msg, void * usr);
   virtual void processDeleteVrfObjectCallback(const DtLocalObject* obj);

   static void taskCompleteReportCallback(DtSimMessage * msg, void * usr);
   virtual void processTaskComplete(DtSimMessage * msg);

protected:
   virtual bool clampOnPlacement() const;

   virtual bool performTechnique();

   virtual bool sendTechniqueTask(const DtSimTaskMessageType& task);

   virtual void performingEmbarkTechnique();

   virtual void performingDisembarkTechnique();

   virtual void moveToEgress();

   virtual void movingToEgress();

   virtual void disembark();

   virtual void sendTask(const DtSimTask& task, const DtUUID& to);

   virtual void removeControlPoint();

   virtual void moveToIngress(const DtUUID& parent);

   virtual void createControlPoint(const DtVector& location,
      const DtUUID& parent);

   virtual void createRoute(const std::vector<DtVector>&, 
      const DtUUID& parent);

   virtual void moveToEmbarkationPoint();

   virtual void atEmbarkationPoint();

   virtual void waitingToStop();

   virtual void movingToIngress();

   virtual void embarkObject(bool overridePosition, 
      const DtVector& loadPosition, int slotNumber,
      const DtUUID& parent, const DtString& slotName = "*", const DtString& slotType = "*", int appearance = 0xFFFFFFFF, 
      const DtTaitBryan& orientation = DtTaitBryan(),
      const DtVector& acceleration = DtVector(), 
      const DtVector& velocty = DtVector(),
      bool invisibleWhenEmbarked = false,
      const DtString& animation = DtString::nullString());
   
   virtual void unloadObject(const DtVector& unloadPoint, int appearance = 0xFFFFFFFF);

   virtual void embark(const DtVector& loadPosition, const DtUUID& parent, 
      int appearance = 0xFFFFFFFF, const DtTaitBryan& orientation = DtTaitBryan(),
      const DtVector& acceleration = DtVector(), 
      const DtVector& velocty = DtVector(),
      bool invisibleWhenEmbarked = false,
      const DtString& animation = DtString::nullString());

   virtual void movingToEmbarkationPoint();

   virtual void stoppedAtEmbarkedPoint();

   virtual void setState(DtVrfEmbarkationPSR::DtEmbarkationControllerState);
   virtual DtVrfEmbarkationPSR::DtEmbarkationControllerState state() const;

   virtual bool isEmbarkationState(DtVrfEmbarkationPSR::DtEmbarkationControllerState) const;

   virtual bool createPSR();

   virtual void setupExistingConditions();

   virtual void completeEmbarkationInformationRequest(
      const DtIfEmbarkationInformation*);

   virtual void embarkationRefused(const DtIfEmbarkationInformation*);

   virtual void completeDisembarkationInformationRequest(
      const DtIfEmbarkationInformation*);

   virtual void disembarkationRefused(const DtIfEmbarkationInformation*);

   virtual DtTaitBryan embarkedOrientation(const DtTaitBryan&, 
      const DtUUID& parent) const;

   virtual void moveToIngressPoint(const DtIfEmbarkationInformation* info);

   virtual void moveAlongToIngressPoint(const DtIfEmbarkationInformation* info);

   virtual void moveToEgressPoint(const DtIfEmbarkationInformation* info);

   virtual void moveAlongToEgressPoint(const DtIfEmbarkationInformation* info);

   virtual void issueMoveToEgressTask();
   virtual void issueMoveToIngressTask();

   virtual void issueMoveAlongToEgressTask();
   virtual void issueMoveAlongToIngressTask();

   virtual void issueMoveToEmbarkationPointTask();

   virtual DtVector currentParentPosition(const DtUUID& parent) const;
   virtual DtTaitBryan currentParentOrientation(const DtUUID& parent) const;
   virtual DtVector currentParentVelocity(const DtUUID& parent) const;
   virtual DtVector currentParentAcceleration(const DtUUID& parent) const;

protected:
   virtual bool requestEmbarkationInformationFrom(const DtUUID& parent,
      bool start = false, int embarkInSlot = -1, const DtString& slotName = "*",
      const DtString& slotType = "*", bool anyIfTaken = true);
   virtual bool requestDisembarkationInformationFrom(const DtUUID& parent,
      bool start = false);

   virtual void requestGiveUpSlot(const DtUUID& parent);

   virtual void waitingForEmbarkationInformation();
   virtual void waitingForDisembarkationInformation();

   virtual void placeObject(bool clamp = false);

   virtual void placeObject(const DtVector& geocLocation, const DtTaitBryan& orientation, bool clamp);

   virtual void setLocation(const DtVector&);

   virtual void calculateAndSetHeading(const DtVector& start, const DtVector& end);

   virtual void sendSetRequest(DtSetDataRequest& request);

   virtual void processDisembarkationState(const DtVector& bodyExitPosition);
   virtual void movingToFinalDestination();
   virtual void moveToFinalDestination();

   virtual void preprocessEmbarkTask();
   virtual void preprocessDisembarkTask();

   virtual bool checkEmbarkOk(const DtUUID& parent) const;

   virtual void updateDisembarkedAppearanceAndAnimation(int appearance);

   virtual void updateEmbarkedAppearanceAndAnimation(int, const DtString&);
   virtual void updateLifeformEmbarkedAppearanceAndAnimation(int, const DtString&);

   virtual void attachToEmbarkedParent(const DtUUID& newParent);

   virtual DtVector fallbackOffloadPoint();

   virtual void enable() override;

   virtual void disable() override;

   virtual DtIfEmbarkationInformation createEmbarkationInformationFromProcessState() const;

   virtual bool parentOnGround();

   static void setHeadingCallback(DtSimMessage*, void* usr);
   virtual void processSetHeading();

private:
   
   DtEmbarkationController();

   DtEmbarkationController(const DtEmbarkationController & 
      orig);

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

protected:
   std::list<DtString>  myEmbarkedObjects;

   DtVrfEmbarkationPSR* myProcessState;

   bool myWaiting;

   DtEmbarkationDescriptor*  myEmbarkationDescriptor;

   double myRequestTime;
   int    myRequestRetries;
   bool myAreCallbacksRegistered;

   bool myUseLoadOverrideIfNoSlotAvailable;
   DtVector myLoadOverridePosition;
   DtUUID myParentToLoadOn;

   bool myResetGroundClampOnDisembark;
   bool myResetGroundClampOnDisembarkValue;
   bool myRemoveSetHeadingNotifyCallback;

   bool myClampOnReceiveEmbarkationInformation;

   DtStringOutputPort*     myOrderedAnimationPort;
   bool myResetAnimationIfNoLongerEmbarked;

   DtMovementLocalObjectFacade myMovementLocalObjectFacade;
   bool myInvisibleSetByUserDuringEmbark = false;
};