ballisticGunController.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfobjcore/entityTargetInformation.h"
#include "vrfobjcore/vrfBalGunPSR.h"
#include "vrfutil/simClock.h"
#include "vrfutil/simMunition.h"
#include <vlpi/disEnums.h>
#include "vrfutil/integerResource.h"
#include "vrfobjcore/weaponInfoInterface.h"

class DtBooleanOutputPort;
class DtIntegerOutputPort;
class DtIntegerInputPort;
class DtBallisticGunControllerDescriptor;
class DtVrfBalGunPSR;
class DtOutputPortGroup;
class DtBooleanInputPort;
class DtWeaponComponentInterface;
class DtEntityListOutputPort;
class DtFireBallisticGunTask;
class DtGenericWeaponInfo;
class DtSpatialFilterEvaluator;

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

public:

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

   virtual ~DtBallisticGunController();

   virtual bool postAddComponentsInit() override;

   virtual const char* type() const override;

   virtual bool init() override;

   virtual void registerTaskMsgCallbacks() override;

   virtual AcceptLevel acceptTask(const DtTaskMessage& task) override;

   virtual void preFirstTickInit() override;

   virtual void tick() override;

   virtual bool createTriggerPort();
   virtual DtBooleanOutputPort * triggerPort() const;

   virtual bool createQuantityOutputPort();
   virtual DtIntegerOutputPort* quantityOutputPort() const;

   virtual bool createLoadedPort();
   virtual DtBooleanOutputPort * loadedPort() const;

   virtual bool createLosOutputPort();
   virtual DtIntegerOutputPort * losOutputPort() const;

   virtual bool createLosInputPort();
   virtual DtIntegerInputPort * losInputPort() const;

   virtual bool createWeaponsHoldInputPort();

   virtual bool createTargetToAcquireOutputPort();

   virtual void setLoadAmmoTime(DtTime loadAmmoTime);
   virtual DtTime loadAmmoTime() const;

   virtual void setUnloadAmmoTime(DtTime unloadAmmoTime);
   virtual DtTime unloadAmmoTime() const;

   virtual void fire();

   virtual bool chooseAmmo(const DtEntityType& targetType,
      const DtUUID& target, DtSimMunition& 
      munition, DtDetonatorFuze& fuze, int& ammoAvailable);

   virtual bool checkCurrentAmmo(int& ammoAvailable);

   virtual bool ammoOKToUse(const DtEntityType& targetType);

   virtual void initProcessSR();

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


   virtual void enable() override;


   virtual void disable() override;

   virtual void clearTask() override;

protected:
   
   virtual bool createPorts() override;

   virtual bool createPortGroups() override;

   virtual void lookupAndCacheProcessSR();


   static void fireBallisticGunTaskCallback(DtSimMessage* msg, void* usr);

   virtual void processFireBallisticGunTask(DtSimMessage* msg);

   bool updateFireBallisticGunTask();

   virtual DtSimTask* createFireTask(const DtRwLocationReference& locRef) const;

   static DtReaderWriter* roundsPerTriggerPullCallback(void* ctrlr);
   virtual DtReaderWriter* provideRoundsPerTriggerPull();

   virtual DtIntegerResource * lookupMunitionResource(const DtString & 
      resource) const;

   void getMunitionResources(std::list<DtString>& resourceList);

   virtual void updateResourceList();

   virtual bool weaponsHoldState();

   static void setResourceCallback(DtSimMessage * msg, void * usrData);
   virtual void processSetResource(DtSimMessage * msg);

   static void setRestoreCallback(DtSimMessage * msg, void * usrData);
   virtual void processSetRestore(DtSimMessage * msg);

   bool outOfAmmo() const;

   virtual bool isSurrenderedLifeform(const DtSimObject* entity) const;

   virtual DtWeaponInfoInterface::TargetApplicability targetApplicability(const DtEntityType& type);

   virtual bool positionWithinTargetRegion(const DtVector& localPosition);
   virtual void setupRegionEvaluator();
   virtual void updateRegionEvaluator();

   virtual DtString weaponId() const;

   virtual bool DtBallisticGunController::createWorkingTargetPoint(const DtVector worldLoc);

   virtual void DtBallisticGunController::deleteWorkingTargetPoint();

protected:
   DtBallisticGunController();

   DtBallisticGunController(const DtBallisticGunController & orig);

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


//=================================================================================================
//=================================================================================================
private:

   bool isFireBallisticGunTasked() const;
   const DtFireBallisticGunTask* getFireBallisticGunTask() const;
   const DtEntityTargetInformation createTargetInfo() const;
   bool hasTarget() const;
   const DtEntityTargetInformation target() const;
   void setRoundsFiredUponTarget(const int& roundsFired);
   const int roundsFiredUponTarget() const;
   const int totalRoundsToFireUponTarget() const;
   void setIsExplicitlyTasked(const bool& explicitlyTasked);
   const bool isExplicitlyTasked() const;
   void setIsInFiringCycle(const bool isIn);
   const bool isInFiringCycle()const;
   void setWeaponStatus(const int weaponStatus);
   const int weaponStatus() const;
   void addWeaponStatus(const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus);
   void removeWeaponStatus(const DtBaseWeaponComponentInterface::DtWeaponStatus weaponStatus);
//=================================================================================================


protected:


   DtIntegerInputPort * myLosInputPort;

   DtBooleanOutputPort *    myTriggerPort;

   DtIntegerOutputPort*     myQuantityOutputPort;

   DtBooleanOutputPort *    myLoadedPort;

   DtIntegerOutputPort* myLosOutputPort;

   DtOutputPortGroup * myGunControlPortGroup;

   DtBooleanInputPort* myWeaponsHoldInputPort;


   DtEntityListOutputPort* myTargetToAcquireOutputPort;

   DtUUID myPreviousTarget;

   DtSimMunition      myCurrentMunition;
   DtDetonatorFuze    myCurrentFuze;

   int              myRoundsAvailable;
 
   DtVrfBalGunPSR*    myProcessState;

   const DtBallisticGunControllerDescriptor* myGunDescriptor;

   bool myWaitingForFire;

   bool myOutOfAmmoWarn;

   DtWeaponComponentInterface* myWeaponComponentInterface;

   DtGenericWeaponInfo* myWeaponInfo;

   DtBoost::shared_ptr<DtSpatialFilterEvaluator> myRegionEvaluator;
   DtTime myLastRegionEvaluatorUpdateTime;
};