dmgCompDesc.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: dmgCompDesc.h,v $ $Revision: 1.17 $ $State: Exp $
*******************************************************************************/



#ifndef DtDamageComponentDescriptor_H_
#define DtDamageComponentDescriptor_H_

#include "vrfobjparam/actCompDesc.h"
#include "vrfobjparam/dmgMunTable.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/vlClock.h"
#include "vrfutil/rwBoolean.h"

class DtSimMunition;
class DtPrbRangeTableEntry;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtDamageComponentDescriptor : public DtActuatorComponentDescriptor
{
public:
   DtDamageComponentDescriptor(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtDamageComponentDescriptor(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   
   DtDamageComponentDescriptor(const DtDamageComponentDescriptor& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   
   DtDamageComponentDescriptor& operator=(
      const DtDamageComponentDescriptor& orig);
   
   virtual ~DtDamageComponentDescriptor();

   virtual DtString type() const;

   virtual DtComponentDescriptor* clone(
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual bool init();

   virtual void setDamageModel(const DtDmgMunitionTable* model);

   virtual const DtDmgMunitionTable* damageModel() const;

   virtual DtReal smokeTime() const;
   virtual void setSmokeTime(DtReal smokeTime);

   virtual DtTime flameTime() const;
   virtual void setFlameTime(DtTime flameTime);

   virtual bool terminateOnDestroy() const;
   virtual void setTerminateOnDestroy(bool yesNo);

   virtual bool getKillProbabilities(const DtSimMunition& munition, const
      DtString& surface, DtReal angleOfIncidence, DtReal range, 
      DtPrbRangeTableEntry * rangeEntry) const;


   virtual void setUnderFireTime(DtTime underFireTime);
   virtual DtTime underFireTime() const;

   virtual DtReal underFireDistance() const;
   virtual void setUnderFireDistance(DtReal underFireDistance);

   virtual bool underFireFromFriendly() const;
   virtual void setUnderFireFromFriendly(bool b);

   virtual void putSelf(FILE* fp, int indentLevel = 0, bool writeUnspecified = false,
      const DtFilename& path = DtReaderWriter::appPath());

   static DtComponentDescriptor* creator();

protected:
   DtDamageComponentDescriptor();

protected:

   DtRwTime                  mySmokeTime;

   DtRwTime                  myFlameTime;

   DtRwBoolean               myTerminateOnDestroy;

   DtRwTime                  myUnderFireTime;

   DtRwReal                  myUnderFireDistance;   

   DtRwBoolean               myUnderFireFromFriendly;
   
   const DtDmgMunitionTable* myDamageModel;


   bool                      myOwnDamageModel;
};

#endif