weaponComponentInterface.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/baseWeaponComponentInterface.h"
#include <vl/hostStructs.h>
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjparam/targetSelectionCriteria.h"
#include "vrfobjcore/entityTargetInformation.h"
#include "vrfutil/rwTemplatedMap.h"

class DtSpatialFilterEvaluator;

class DT_DLL_vrfobjcore DtWeaponComponentInterface : public DtBaseWeaponComponentInterface
{
public:

   typedef DtRwTemplatedMapPtr<DtRwUUID, DtRwUUID> MunitionToTargetMap;

private:
   DtWeaponComponentInterface();

public:
   //constructor
   DtWeaponComponentInterface(const 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 clearTarget();
   virtual bool hasTarget() const;


   virtual void addTargetFiringUpon(const DtUUID& target);
   virtual void removeTargetFiringUpon(const DtUUID& target);
   virtual const DtRwTemplatedUUIDList& targetsFiringUpon() const;


   virtual void addMunitionFired(const DtUUID& munition, const DtUUID& target);
   virtual void removeMunitionFired(const DtUUID& munition);
   virtual const MunitionToTargetMap& munitionsFired() const;

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

protected:
   virtual void setupRegionEvaluator();

protected:
   DtTargetSelectionCriteria myTargetSelectionCriteria;

   DtEntityTargetInformation myTarget;

   DtRwTemplatedUUIDList myTargetsFiringUpon;

   MunitionToTargetMap myMunitions;

   DtSpatialFilterEvaluator* myRegionEvaluator;
};