ballisticGun.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/actuatorComponent.h"
#include "vrfobjcore/platformLocalObjectFacade.h"
#include <vrfMsgTransport/fireEvent.h>
#include <vrfMsgTransport/detonationEvent.h>
#include "vrfcore/timer.h"
#include "vrfutil/simMunition.h"

class DtSimulationServices;
class DtBallisticGunDescriptor;
class DtVrfBalGunPSR;
class DtDetonationDescriptor;
class DtIntegerInputPort;
class DtAmmunitionInputPort;
class DtBooleanInputPort;
class DtAnalogInputPort;
class DtInputPortGroup;

#define DEBUG_MUZZLE_POSITION 0

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtBallisticGun : public DtActuatorComponent
{

public:

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


   virtual ~DtBallisticGun();

   virtual bool init();

   virtual void initPendingDetonations();

   virtual const char* type() const;

   virtual void preFirstTickInit();

   virtual void tick();

   virtual void fire(int roundsToFire, bool computePHit);

   virtual bool checkHitProbability(const DtEntityType& type, DtReal 
      range, bool& probabilityEntryFound, int burstSize = 1);

   virtual double hitProbabilityModifier(const DtEntityType& type, 
      DtReal range, int burstSize = 1);

   virtual double targetMotionHitModifier(const DtEntityType& type, DtReal
      range);

   virtual double selfMotionHitModifier(const DtEntityType& type, DtReal
      range);

   virtual double skillLevelModifier(const double range);

   virtual double lifeformPostureModifier();

   virtual double burstSizeModifier(int burstSize);
   
   virtual makVrfEvents::DtFireEvent * createFireInteraction(const int rounds);

   virtual makVrfEvents::DtDetonationEvent * createDetonationInteraction(
      int burstSize,
      DtTime& detTime, bool& isHit,
      bool assureMiss = false);

   virtual void getMissLocation(DtVector gunPosition, 
      const DtSimObject *intendedTarget, double muzzleSpeed,
      DtVector& missLocation, DtVector& velocityVector,
      DtDetonationResult& detonationResult,
      DtSimObjectReference* target, bool allowHitIntendedTarget);

   virtual void scheduleDetonation(makVrfEvents::DtDetonationEvent * detInter,
      DtTime detTime);

   virtual DtString probabilityString() const;

   virtual DtVector calculateMuzzlePosition() const;

   virtual DtVector calculateGunOffset() const;

   virtual makVrfEvents::DtDetonationEvent * createDetonationInteraction(
      const DtDetonationDescriptor& desc, DtTime& detTime);

   virtual DtDetonationDescriptor* createDetonationDescriptor(
      makVrfEvents::DtDetonationEvent* detInter, DtTime simTime);

   virtual double maxGunRange() const;

#if DEBUG_MUZZLE_POSITION
   virtual bool taskVisualizationsActive() const { return true; };
#endif

public:

   static void detonationCallback(DtTimer * timer);

   static void setTracerUseCallback(DtSimMessage * msg, void *component);
   virtual void processSetTracerUse(DtSimMessage* msg);

   static DtReaderWriter* getMuzzlePositionAttribute(void *ctrlr);
   virtual DtReaderWriter* getMuzzlePositionAttribute();

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

protected:
   
   virtual bool createPortGroups();

   virtual bool createPorts();

   virtual bool createPSR();

   virtual void processSimObjectAdded(DtSimObjectReference vrfObject);

   virtual void addRangeItems();

   virtual bool aimGun();

   virtual DtEntityType munitionType(DtSimMunition& munitionEntry);

#if DEBUG_MUZZLE_POSITION
   virtual void updateTaskVisualizations();
#endif

protected:
   
   DtBallisticGun();

   DtBallisticGun(const DtBallisticGun & orig);

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

protected:
   DtBallisticGunDescriptor    * myBalGunDescriptor;

   DtReal             myMaxGunRange;

   DtReal             myMuzzleSpeed;
   DtVector           myMuzzleOffset;

   DtSimObjectReference        myCurrentTarget;
   DtReal             myCurrentRange;

   DtList             myTimerList;
   DtArtPartType      myGunArtPart;
   DtString           myCurrentEventId;

   DtVrfBalGunPSR*    myProcessState;


   DtInputPortGroup      *myBalGunControlPortGroup;

   DtBooleanInputPort    *myTriggerPort;

   DtIntegerInputPort*  myQuantityInputPort;

   DtBooleanInputPort    *myLoadedPort;

   DtIntegerInputPort          *myLosPort;

   DtAnalogInputPort*  myAimElevationInputPort;


   boost::signals2::scoped_connection mySimObjectAddedConnection;

   DtPlatformLocalObjectFacade myPlatformLocalObjectFacade;
   DtMovementSimObjectFacade myCurrentTargetSimObjectFacade;
};