ballisticGunDescriptor.h

Go to the documentation of this file.

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



#ifndef DtBallisticGunDescriptor_H_
#define DtBallisticGunDescriptor_H_


#include "vrfobjparam/actuatorComponentDescriptor.h"
#include <readerWriter/rwString.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwInt.h>
#include "readerWriter/rwVector.h"
#include <readerWriter/readerWriterFile.h>
#include <readerWriter/rwBoolean.h>
#include "vrfobjparam/rangeProbabilityTable.h"

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

   virtual DtString type() const;

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

   virtual DtReal muzzleSpeed() const;
   virtual void setMuzzleSpeed(DtReal muzzleSpeed);

   virtual int roundsPerMagazine() const;
   virtual void setRoundsPerMagazine(int roundsPerMagazine);

   virtual int roundsPerMinute() const;
   virtual void setRoundsPerMinute(const int roundsPerMinute);

   virtual DtReal extraTimeBetweenBursts() const;
   virtual void setExtraTimeBetweenBursts(const DtReal extraTimeBetweenBursts);

   virtual bool startWithTracers() const;
   virtual void setStartWithTracers(const bool);

   virtual const DtString& rangeName() const;
   virtual void setRangeName(const DtString& rangeName);

   virtual int rangeId() const;
   virtual void setRangeId(int rangeId);
   virtual bool rangeIdIsSpecified() const;

   virtual DtReal elevationRate() const;
   virtual void setElevationRate(DtReal pElevationRate);
   virtual bool isElevationRateSpecified() const;

   virtual DtReal maxElevationRange() const;
   virtual void setMaxElevationRange(DtReal pElevationRange);
   virtual bool isMaxElevationRangeSpecified() const;

   virtual DtReal minElevationRange() const;
   virtual void setMinElevationRange(DtReal pElevationRange);
   virtual bool isMinElevationRangeSpecified() const;

   virtual DtReal neutralElevation() const;
   virtual void setNeutralElevation(DtReal elevation);
   virtual bool isNeutralElevationSpecified() const;

   virtual const DtVector& muzzleOffset() const;
   virtual void setMuzzleOffset(const DtVector& muzzleOffset);
   virtual bool isMuzzleOffsetSpecified() const;

   virtual bool velocityCheck() const;
   virtual void setVelocityCheck(bool check);

   virtual const DtString& hitProbabilityFilename();
   virtual void setHitProbabilityFilename(const DtString& filename);

   virtual const DtRangeProbabilityTable& hitProbabilityTable() const;
   virtual void setHitProbabilityTable(const DtRangeProbabilityTable& table);

   virtual bool detonateOnMiss() const;
   virtual void setDetonateOnMiss(bool detonateOnMiss);

   virtual bool hitOwnForce() const;
   virtual void setHitOwnForce(bool hitOwnForce);

   virtual int roundsPerDetonation() const;
   virtual void setRoundsPerDetonation(const int rpd);

   virtual double maxSkillLevelEffect() const;
   virtual void setMaxSkillLevelEffect(const double teffect);
   

   virtual double burstCep() const;
   virtual void setBurstCep(const double radius);

   static DtComponentDescriptor* creator();

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

protected:
   DtBallisticGunDescriptor();

protected:

   DtRwReal                    myElevationRate;

   DtRwReal                    myMaxElevationRange;

   DtRwReal                    myMinElevationRange;

   DtRwReal                    myNeutralElevation;

   DtRwReal                    myMuzzleSpeed;

   DtRwInt                     myRoundsPerMagazine;

   DtRwInt                     myRoundsPerMinute;

   DtRwReal                    myExtraTimeBetweenBursts;

   DtRwBoolean                 myStartWithTracers;

   DtRwOffsetVector                  myMuzzleOffset;

   DtRwBoolean                  myVelocityCheck;

   DtReaderWriterFile          myHitProbabilityFile;

   DtRangeProbabilityTable     myHitProbabilityTable;

    DtRwString                 myRangeName;

   DtRwInt                     myRangeId;

   DtRwBoolean                 myDetonateOnMiss;

   DtRwBoolean                 myHitOwnForce;

   DtRwInt                     myRoundsPerDetonation;

   DtRwReal                     myBurstCep;

   DtRwReal                     myMaxSkillLevelEffect;



};

#endif