VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
baseWeaponControllerDescriptor.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2003 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 /*******************************************************************************
6 ** $RCSfile: basWpnCtlDesc.h,v $ $Revision: 1.11 $ $State: Exp $
7 *******************************************************************************/
8 
11 
14 
15 #ifndef DtBaseWeaponControllerDescriptor_H_
16 #define DtBaseWeaponControllerDescriptor_H_
17 
19 #include <readerWriter/rwReal.h>
20 #include <readerWriter/rwBoolean.h>
22 #include "vrfutil/simClock.h"
23 
31 {
32 public:
35  DtReaderWriterRegistry* parentRegistry = nullptr);
36 
38  DtReaderWriterRegistry* parentRegistry = nullptr);
39 
43  DtReaderWriterRegistry* parentRegistry = nullptr);
44 
48 
51 
54  virtual DtString type() const override;
55 
57  DtReaderWriterRegistry* parentRegistry = nullptr) const override;
58 
61  virtual bool preloadWeapon() const;
62  virtual void setPreloadWeapon(bool preloadWeapon);
64 
67  virtual DtReal maxVehicleSpeedToFire() const;
68  virtual void setMaxVehicleSpeedToFire(DtReal maxVehicleSpeedToFire);
70 
73  virtual DtReal maxAzimuthAngleOffBoresight() const;
74  virtual void setMaxAzimuthAngleOffBoresight(DtReal maxAngle);
76 
79  virtual DtReal maxElevationAngleOffBoresight() const;
80  virtual void setMaxElevationAngleOffBoresight(DtReal maxAngle);
82 
85  virtual DtTime loadAmmoTime() const;
86  virtual void setLoadAmmoTime(DtTime loadTime);
88 
91  virtual DtTime unloadAmmoTime() const;
92  virtual void setUnloadAmmoTime(DtTime unloadTime);
94 
97 
98  virtual bool disabledBySuppression() const;
99  virtual void setDisabledBySuppression(const bool isDisabled);
101 
103 
104  virtual bool stowable() const;
105  virtual void setStowable(bool v);
107 
109 
110  virtual bool controlLauncherAppearance() const;
111  virtual void setControlLauncherAppearance(bool v);
113 
115  static DtComponentDescriptor* creator();
116 
117 protected:
120 
121 protected:
125 
134 
144 
154 
167 
174 
181 
189 
197 
204 
213 };
214 
215 #endif
This class allows one to collect and compare strings using an index number instead of having to do st...
Definition: symbolString.h:27
DtRwBoolean myDisabledBySuppression
Parameter Name: disabled-by-suppression Parameter Description: A boolean that indicates if this weapo...
Definition: baseWeaponControllerDescriptor.h:196
DtRwBoolean myControlLauncherAppearance
Parameter Name: control-launcher-appearance Parameter Description: Indicates if this weapon should se...
Definition: baseWeaponControllerDescriptor.h:211
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28
DtRwTime myLoadAmmoTime
Parameter Name: load-ammo-time Parameter Description: The time delay from the time an ammo is selecte...
Definition: baseWeaponControllerDescriptor.h:180
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49
DtRwReal myMaxAngleOffBoresight
Parameter Name: max-angle-off-boresight Parameter Description: NOTE: This parameter is deprecated...
Definition: baseWeaponControllerDescriptor.h:166
Definition: readerWriterRegistry.h:39
DtComponentDescriptor & operator=(const DtComponentDescriptor &orig)
assignment
DtRwBoolean myDoWeaponPreload
Parameter Name: preload-weapon Parameter Description: Setting PreloadWeapon to True will result in t...
Definition: baseWeaponControllerDescriptor.h:173
File: vlClock.h.
virtual DtComponentDescriptor * clone(DtReaderWriterRegistry *parentRegistry=NULL) const
DtRwReal myFireMaxVehicleSpeed
Parameter Name: max-vehicle-speed-to-fire Parameter Description: Some vehicles must stop to shoot...
Definition: baseWeaponControllerDescriptor.h:133
DtBaseWeaponControllerDescriptor; descriptor for the DtBaseWeaponController component.
Definition: baseWeaponControllerDescriptor.h:30
DtRwReal myMaxAzimuthAngleOffBoresight
Parameter Name: max-azimuth-angle-off-boresight Parameter Description: Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians of azimuth off of boresight the target can be and still reasonably fire the weapon. Parameter Default Value: 0.005 Parameter Units: radians.
Definition: baseWeaponControllerDescriptor.h:143
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtRwTime myUnloadAmmoTime
Parameter Name: unload-ammo-time Parameter Description: The time is takes to remove ammo (of the wron...
Definition: baseWeaponControllerDescriptor.h:188
virtual DtString type() const
Returns the type of component this descriptor describes. Used to create the descriptor on read from a...
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
static DtComponentDescriptor * creator()
DtRwReal myMaxElevationAngleOffBoresight
Parameter Name: max-elevation-angle-off-boresight Parameter Description: Some munitions, especially missiles, can be fired before the launcher is pointing at the target, since the missile can maneuver to reach the target. This method allows the user to set the maximum number of radians of elevation off of boresight the target can be and still reasonably fire the weapon. Parameter Default Value: 0.005 Parameter Units: radians.
Definition: baseWeaponControllerDescriptor.h:153
DtRwBoolean myStowable
Parameter Name: stowable Parameter Description: A boolean that indicates if this weapon is able to be...
Definition: baseWeaponControllerDescriptor.h:203

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)