From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_weapon_design.html | 1944 +++++++++++++++++++++++++++++ 1 file changed, 1944 insertions(+) create mode 100644 Doc/doxygen/html/class_weapon_design.html (limited to 'Doc/doxygen/html/class_weapon_design.html') diff --git a/Doc/doxygen/html/class_weapon_design.html b/Doc/doxygen/html/class_weapon_design.html new file mode 100644 index 0000000..1281e03 --- /dev/null +++ b/Doc/doxygen/html/class_weapon_design.html @@ -0,0 +1,1944 @@ + + + + + +Starshatter_Open: WeaponDesign Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Public Attributes
+
+
WeaponDesign Class Reference
+
+
+ +

#include <WeaponDesign.h>

+ +

List of all members.

+ + + +

+Public Types

enum  CONSTANTS { DMG_NORMAL = 0, +DMG_EMP = 1, +DMG_POWER = 2, +MAX_STORES = 8 + }
+ + + + +

+Public Member Functions

 WeaponDesign ()
 ~WeaponDesign ()
int operator== (const WeaponDesign &rhs) const
+ + + + + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static void Initialize (const char *filename)
static void Close ()
static WeaponDesign * Get (int type)
static WeaponDesign * Find (const char *name)
static WeaponDesign * FindModDesign (const char *name)
static void ClearModCatalog ()
static int GetDesignList (List< Text > &designs)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

int type
Text name
Text group
Text description
bool secret
bool drone
bool primary
bool beam
bool self_aiming
bool syncro
bool flak
int guided
int value
int decoy_type
bool probe
DWORD target_type
Vec3 muzzle_pts [MAX_STORES]
int nbarrels
bool visible_stores
Vec3 attachments [MAX_STORES]
int nstores
Vec3 eject
float firing_cone
float aim_az_max
float aim_az_min
float aim_az_rest
float aim_el_max
float aim_el_min
float aim_el_rest
float slew_rate
int turret_axis
float capacity
float recharge_rate
float refire_delay
float salvo_delay
int ammo
int ripple_count
float charge
float min_charge
float carry_mass
float carry_resist
int damage_type
float damage
float penetration
float speed
float life
float mass
float drag
float thrust
float roll_rate
float pitch_rate
float yaw_rate
float roll_drag
float pitch_drag
float yaw_drag
float integrity
float lethal_radius
float det_range
Text det_child
int det_count
float det_spread
float min_range
float max_range
float max_track
int graphic_type
float width
float length
float scale
float explosion_scale
float light
Color light_color
float flash_scale
float flare_scale
float spread_az
float spread_el
Text anim_frames [16]
int anim_length
Text beauty
Text bitmap
Text model
Text turret
Text turret_base
Text trail
Text flash
Text flare
Text sound
Bitmap * beauty_img
Bitmap * animation
Bitmap * shot_img
Bitmap * trail_img
Bitmap * flash_img
Bitmap * flare_img
Model * shot_model
Model * turret_model
Model * turret_base_model
Sound * sound_resource
int trail_length
float trail_width
int trail_dim
+

Detailed Description

+
+

Definition at line 32 of file WeaponDesign.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum WeaponDesign::CONSTANTS
+
+
Enumerator:
+ + + + +
DMG_NORMAL  +
DMG_EMP  +
DMG_POWER  +
MAX_STORES  +
+
+
+ +

Definition at line 37 of file WeaponDesign.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
WeaponDesign::WeaponDesign ()
+
+ +

Definition at line 42 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + + + +
WeaponDesign::~WeaponDesign ()
+
+ +

Definition at line 146 of file WeaponDesign.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
void WeaponDesign::ClearModCatalog ()
+ 		+static
+
+ +

Definition at line 173 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void WeaponDesign::Close ()
+ 		+static
+
+ +

Definition at line 166 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
WeaponDesign * WeaponDesign::Find (const char * name)
+ 		+static
+
+ +

Definition at line 665 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
WeaponDesign * WeaponDesign::FindModDesign (const char * name)
+ 		+static
+
+ +

Definition at line 688 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
WeaponDesign * WeaponDesign::Get (int type)
+ 		+static
+
+ +

Definition at line 649 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int WeaponDesign::GetDesignList (List< Text > & designs)
+ 		+static
+
+ +

Definition at line 711 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void WeaponDesign::Initialize (const char * filename)
+ 		+static
+
+ +

Definition at line 157 of file WeaponDesign.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int WeaponDesign::operator== (const WeaponDesign & rhs) const
+ 		+inline
+
+ +

Definition at line 46 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* WeaponDesign::TYPENAME ()
+ 		+inlinestatic
+
+ +

Definition at line 35 of file WeaponDesign.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
float WeaponDesign::aim_az_max
+
+ +

Definition at line 89 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::aim_az_min
+
+ +

Definition at line 90 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::aim_az_rest
+
+ +

Definition at line 91 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::aim_el_max
+
+ +

Definition at line 92 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::aim_el_min
+
+ +

Definition at line 93 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::aim_el_rest
+
+ +

Definition at line 94 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::ammo
+
+ +

Definition at line 103 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::anim_frames[16]
+
+ +

Definition at line 155 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::anim_length
+
+ +

Definition at line 156 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Bitmap* WeaponDesign::animation
+
+ +

Definition at line 168 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Vec3 WeaponDesign::attachments[MAX_STORES]
+
+ +

Definition at line 83 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::beam
+
+ +

Definition at line 67 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::beauty
+
+ +

Definition at line 157 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Bitmap* WeaponDesign::beauty_img
+
+ +

Definition at line 167 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::bitmap
+
+ +

Definition at line 158 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::capacity
+
+ +

Definition at line 99 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::carry_mass
+
+ +

Definition at line 109 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::carry_resist
+
+ +

Definition at line 110 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::charge
+
+ +

Definition at line 107 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::damage
+
+ +

Definition at line 114 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::damage_type
+
+ +

Definition at line 113 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::decoy_type
+
+ +

Definition at line 73 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::description
+
+ +

Definition at line 62 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::det_child
+
+ +

Definition at line 132 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::det_count
+
+ +

Definition at line 133 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::det_range
+
+ +

Definition at line 131 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::det_spread
+
+ +

Definition at line 134 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::drag
+
+ +

Definition at line 120 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::drone
+
+ +

Definition at line 65 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Vec3 WeaponDesign::eject
+
+ +

Definition at line 85 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::explosion_scale
+
+ +

Definition at line 146 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::firing_cone
+
+ +

Definition at line 88 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::flak
+
+ +

Definition at line 70 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::flare
+
+ +

Definition at line 164 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Bitmap* WeaponDesign::flare_img
+
+ +

Definition at line 172 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::flare_scale
+
+ +

Definition at line 150 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::flash
+
+ +

Definition at line 163 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Bitmap* WeaponDesign::flash_img
+
+ +

Definition at line 171 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::flash_scale
+
+ +

Definition at line 149 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::graphic_type
+
+ +

Definition at line 142 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::group
+
+ +

Definition at line 61 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::guided
+
+ +

Definition at line 71 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::integrity
+
+ +

Definition at line 128 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::length
+
+ +

Definition at line 144 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::lethal_radius
+
+ +

Definition at line 129 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::life
+
+ +

Definition at line 118 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::light
+
+ +

Definition at line 147 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Color WeaponDesign::light_color
+
+ +

Definition at line 148 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::mass
+
+ +

Definition at line 119 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::max_range
+
+ +

Definition at line 138 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::max_track
+
+ +

Definition at line 139 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::min_charge
+
+ +

Definition at line 108 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::min_range
+
+ +

Definition at line 137 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::model
+
+ +

Definition at line 159 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Vec3 WeaponDesign::muzzle_pts[MAX_STORES]
+
+ +

Definition at line 78 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::name
+
+ +

Definition at line 60 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::nbarrels
+
+ +

Definition at line 79 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::nstores
+
+ +

Definition at line 84 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::penetration
+
+ +

Definition at line 116 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::pitch_drag
+
+ +

Definition at line 126 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::pitch_rate
+
+ +

Definition at line 123 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::primary
+
+ +

Definition at line 66 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::probe
+
+ +

Definition at line 74 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::recharge_rate
+
+ +

Definition at line 100 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::refire_delay
+
+ +

Definition at line 101 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::ripple_count
+
+ +

Definition at line 104 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::roll_drag
+
+ +

Definition at line 125 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::roll_rate
+
+ +

Definition at line 122 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::salvo_delay
+
+ +

Definition at line 102 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::scale
+
+ +

Definition at line 145 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::secret
+
+ +

Definition at line 63 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::self_aiming
+
+ +

Definition at line 68 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Bitmap* WeaponDesign::shot_img
+
+ +

Definition at line 169 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Model* WeaponDesign::shot_model
+
+ +

Definition at line 173 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::slew_rate
+
+ +

Definition at line 95 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::sound
+
+ +

Definition at line 165 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Sound* WeaponDesign::sound_resource
+
+ +

Definition at line 176 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::speed
+
+ +

Definition at line 117 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::spread_az
+
+ +

Definition at line 152 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::spread_el
+
+ +

Definition at line 153 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::syncro
+
+ +

Definition at line 69 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
DWORD WeaponDesign::target_type
+
+ +

Definition at line 75 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::thrust
+
+ +

Definition at line 121 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::trail
+
+ +

Definition at line 162 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::trail_dim
+
+ +

Definition at line 180 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Bitmap* WeaponDesign::trail_img
+
+ +

Definition at line 170 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::trail_length
+
+ +

Definition at line 178 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::trail_width
+
+ +

Definition at line 179 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::turret
+
+ +

Definition at line 160 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::turret_axis
+
+ +

Definition at line 96 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Text WeaponDesign::turret_base
+
+ +

Definition at line 161 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Model* WeaponDesign::turret_base_model
+
+ +

Definition at line 175 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
Model* WeaponDesign::turret_model
+
+ +

Definition at line 174 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::type
+
+ +

Definition at line 59 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
int WeaponDesign::value
+
+ +

Definition at line 72 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
bool WeaponDesign::visible_stores
+
+ +

Definition at line 82 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::width
+
+ +

Definition at line 143 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::yaw_drag
+
+ +

Definition at line 127 of file WeaponDesign.h.

+ +
+
+ +
+
+ + + + +
float WeaponDesign::yaw_rate
+
+ +

Definition at line 124 of file WeaponDesign.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1