weaponComponentInterface.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/processSR.h"
#include <vl/hostStructs.h>
#include "vrfutil/rwString.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwVector.h"
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjparam/targetSelectCriteria.h"
#include "vrfobjcore/entityTargetInformation.h"

class DtSpatialFilterEvaluator;

class DT_DLL_vrfobjcore DtWeaponComponentInterface : public DtVrfProcessStateRepository
{
public:
   
   enum DtWeaponStatus
   {
      DT_OK_TO_FIRE                 = 0,
      DT_WEAPON_DISABLED            = 1,
      DT_NO_AMMUNITION_FOR_TARGET   = 2,
      DT_CANNOT_ACQUIRE_TARGET      = 4      
   };

private:
   DtWeaponComponentInterface();

public:
   //constructor
   DtWeaponComponentInterface(DtVrfObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   //copy constructor
   DtWeaponComponentInterface(const DtWeaponComponentInterface& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   //assignment operator
   const DtWeaponComponentInterface& operator=( 
      const DtWeaponComponentInterface& orig);

   //destructor
   virtual ~DtWeaponComponentInterface();

   //returns a copy of the PSR
   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual DtString type() const;


   virtual void setTargetSelectionCriteria(const DtTargetSelectionCriteria& tsc);
   virtual const DtTargetSelectionCriteria& targetSelectionCriteria() const;

   virtual void updateRegionEvaluator();
   virtual bool locationWithinRegion(const DtVector& localLocation) const;

   virtual void setTarget(const DtEntityTargetInformation& target);
   virtual const DtEntityTargetInformation& target() const;

   virtual void setRoundsFiredUponTarget(const int& roundsFired);
   virtual const int roundsFiredUponTarget() const;

   virtual void setTotalRoundsToFireUponTarget(const int& totalRoundsToFire);
   virtual const int totalRoundsToFireUponTarget() const;


   virtual void setIsExplicitlyTasked(const bool& explicitlyTasked);
   virtual const bool isExplicitlyTasked() const;


   virtual void setAllowExplicitTasking(const bool& includeInDialogs);
   virtual const bool allowExplicitTasking() const;


   virtual void setDisplayName(const DtString& displayName);
   virtual const DtString displayName() const;


   virtual void setWeaponStatus(const int weaponStatus);
   virtual const int weaponStatus() const;


   virtual void clearTarget();
   virtual bool hasTarget() const;

   static DtVrfProcessStateRepository* creator(const DtString& name,
      DtVrfObject* vrfObject, DtReaderWriterRegistry* parentRegistry);

protected:
   virtual void setupRegionEvaluator();

protected:
   DtTargetSelectionCriteria myTargetSelectionCriteria;

   DtEntityTargetInformation myTarget;

   DtSpatialFilterEvaluator* myRegionEvaluator;

   DtRwInt myRoundsFiredUponTarget;
   
   DtRwInt myTotalRoundsToFireUponTarget;
   
   DtRwBoolean myIsExplicitlyTasked;

   DtRwBoolean myAllowExplicitTasking;

   DtRwString myDisplayName;

   DtVrfObject* myHostObject;

   DtRwInt myWeaponStatus;
};