include/vrfmodel/damageAdjudicationActuator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/******************************************************************************
** $RCSfile: damageAdjudicationActuator.h,v $ $Revision: 1.16 $ $State: Exp $
*******************************************************************************/




#ifndef damageAdjudicationActuator_H_
#define damageAdjudicationActuator_H_

#include "vrfobjcore/actCmpnt.h"

#include <geometry/boundingVolumeFace.h>

class DtDetonationContext;
class DtDamageAdjudicationComponentDescriptor;
class DtSimMessage;
class DtSimBaseRadio;
class DtPrbRangeTableEntry;



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

public:

   DtDamageAdjudicationActuator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtDamageAdjudicationActuator();

   virtual bool init();

   static bool processDirectDetonationCallback(const DtDetonationContext& detonationContext, void* usr);

   static bool processCollateralDetonationCallback(const DtDetonationContext& detonationContext, void* usr);

   
   virtual bool adjudicateDirectDamage(const DtDetonationContext& detonationContext);

   virtual bool adjudicateCollateralDamage(const DtDetonationContext& detonationContext);

   virtual DtString type() const;

   virtual void tick();

   static void setDestroyedCallback(DtSimMessage* msg, void* usrData);

   static void setRestoredCallback(DtSimMessage* msg, void* usrData);

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

protected:

   virtual void getDirectFireSurfaceAndAngleOfIncidence(DtDetonationContext& detonationContext);

   virtual void getIndirectFireSurfaceAndAngleOfIncidence(DtDetonationContext& detonationContext);

   virtual DtSymbolString getSurface(DtBoundingVolumeFace impactSurface);

   virtual bool getRangeEntry(const DtDetonationContext& detonationContext,
      DtPrbRangeTableEntry& rangeEntry, bool isDirectDamage = true) const;

   virtual bool isCatastrophicallyKilled(DtPrbRangeTableEntry& rangeEntry, 
      DtSymbolString catastrophicKillString) const;

   virtual bool isFirepowerKilled(DtPrbRangeTableEntry& rangeEntry, 
      DtSymbolString firepowerKillString) const;
   
   virtual bool isMobilityKilled(DtPrbRangeTableEntry& rangeEntry, 
      DtSymbolString mobilityKillString) const;


   virtual DtSymbolString catastrophicKillString() const;

   virtual DtSymbolString mobilityKillString() const;

   virtual DtSymbolString firepowerKillString() const;

   virtual void determineDestroyedStatus();


   virtual bool isRegisteredForDetonations() const;
   virtual void setIsRegisteredForDetonations(bool yesOrNo);

   virtual void setDestroyed();

   virtual void setRestored();

   virtual bool registerForDetonations();

   virtual bool unregisterForDetonations();

   virtual void setMobilityKilled();

   virtual void setFirepowerKilled();

   virtual void setRadio(DtSimBaseRadio* radio);

protected:
   
   DtDamageAdjudicationComponentDescriptor* myDamageComponentDescriptor;
   DtTime                       myStopSmokingTime;
   DtTime                       myStopFlamingTime;


private:
   
   DtDamageAdjudicationActuator();

   DtDamageAdjudicationActuator(const DtDamageAdjudicationActuator& orig);

   DtDamageAdjudicationActuator& operator=(const DtDamageAdjudicationActuator& orig);

private:
   bool myIsRegisteredForDetonations;
};

#endif