1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*
* Created by Ian "Goober5000" Warfield for the FreeSpace2 Source Code Project.
* You may not sell or otherwise commercially exploit the source or things you
* create based on the source.
*/
#ifndef _OBJECT_DOCK_H
#define _OBJECT_DOCK_H
#include "globalincs/globals.h"
#include "globalincs/pstypes.h"
class object;
// info for each docked object
typedef struct dock_instance {
dock_instance *next; // next item in list
int dockpoint_used; // index into polymodel->docking_bays[]
object *docked_objp; // object that is docked to me
} dock_instance;
// class used when a function must be evaluated for all docked objects
// (it's a class because it has a constructor)
class dock_function_info
{
public:
// Set this to true when the function should return early.
bool early_return_condition;
// The following were originally unions, but it became necessary to use structs
// for certain functions that need to maintain two or more values.
struct {
double double_value;
object* objp_value;
vec3d* vecp_value;
vec3d* vecp_value2;
matrix* matrix_value;
float float_value;
int int_value;
bool bool_value;
char char_value;
} parameter_variables, maintained_variables;
// constructor to initialize everything to 0
// (This used to memset the entire class (which at the time was a struct) to 0, but that hosed the function address table. Fortunately, by the time the constructor
// was called, the address table wasn't needed any more! It's now revised because it's best to keep the code robust in case of future unanticipated changes.)
dock_function_info()
: early_return_condition(false)
{
memset(¶meter_variables, 0, sizeof(parameter_variables));
memset(&maintained_variables, 0, sizeof(maintained_variables));
}
};
enum axis_type
{
X_AXIS,
Y_AXIS,
Z_AXIS
};
// get the first object in objp's dock list
object *dock_get_first_docked_object(object *objp);
// check whether objp is part of a docked pair
bool dock_check_docked_one_on_one(object *objp);
// count objects directly docked to objp
int dock_count_direct_docked_objects(object *objp);
// count objects directly or indirectly docked with objp
int dock_count_total_docked_objects(object *objp);
// check whether other_objp is directly docked to objp
bool dock_check_find_direct_docked_object(object *objp, object *other_objp);
// check whether other_objp is directly or indirectly docked to objp
bool dock_check_find_docked_object(object *objp, object *other_objp);
// find the object occupying objp's specified dockpoint
object *dock_find_object_at_dockpoint(object *objp, int dockpoint);
// find objp's dockpoint being occupied by other_objp
int dock_find_dockpoint_used_by_object(object *objp, object *other_objp);
// calculate the local center of all docked objects (returned in dest)
void dock_calc_docked_actual_center(vec3d *dest, object *objp);
// calculate the local mins and maxs of all docked objects
void dock_calc_docked_extents(vec3d *mins, vec3d *maxs, object *objp);
// calculate the center of mass of all docked objects (returned in dest)
// currently the game assumes the center of mass is the center of an object; this will need to
// be fixed eventually (though this function does weight the object masses properly)
// returns the total mass of docked ships, calculated as a side effect
float dock_calc_docked_center_of_mass(vec3d *dest, object *objp);
// sum the masses of all directly or indirectly docked ships
float dock_calc_total_docked_mass(object *objp);
// calculate cross-sectional radius of a set of docked models
float dock_calc_max_cross_sectional_radius_perpendicular_to_axis(object *objp, axis_type axis);
// *insert sophomoric jokes here*
// The semilatus rectum is analagous to the radius, but restricted to one dimension (whereas the radius
// covers two dimensions). It is half of the latus rectum. More information can be found in Wikipedia
// or in any math textbook. :p
float dock_calc_max_semilatus_rectum_parallel_to_axis(object *objp, axis_type axis);
// calculate the overall forward speed of the entire docked mass
float dock_calc_docked_fspeed(object *objp);
// calculate the overall speed of the entire docked mass
float dock_calc_docked_speed(object *objp);
// Überfunction for evaluating all objects that could possibly be docked to objp. This will
// call "function" for each docked object. The function should store its intermediate and
// return values in the dock_function_info class.
void dock_evaluate_all_docked_objects(object *objp, dock_function_info *infop, void (*function)(object *, dock_function_info *));
// moves all docked objects; called only from obj_move_all in object.cpp
void dock_move_docked_objects(object *objp);
// add objp1 and objp2 to each others' dock lists; currently only called by ai_do_objects_docked_stuff
void dock_dock_objects(object *objp1, int dockpoint1, object *objp2, int dockpoint2);
// remove objp1 and objp2 from each others' dock lists; currently only called by ai_do_objects_undocked_stuff
void dock_undock_objects(object *objp1, object *objp2);
// apply force to a docked assembly of ships
void dock_calculate_and_apply_whack_docked_object(vec3d* force, const vec3d* hit_pos, object* objp);
/**
* @brief Undocks everything from the given object
* @note This is a slow method. use dock_free_dock_list() when doing object cleanup.
* @note Currently, this function cannot be called from within ship_cleanup() [Github Issue #1177:https://github.com/scp-fs2open/fs2open.github.com/issues/1177]
*/
void dock_undock_all(object *objp);
// free the entire dock list without undocking anything; should only be used on object cleanup
void dock_free_dock_list(object *objp);
// flag set/remove helpers required in multiple places
void object_set_arriving_stage1_ndl_flag_helper(object *objp, dock_function_info * /*infop*/ );
void object_remove_arriving_stage1_ndl_flag_helper(object *objp, dock_function_info * /*infop*/ );
void object_set_arriving_stage2_ndl_flag_helper(object *objp, dock_function_info * /*infop*/ );
void object_remove_arriving_stage2_ndl_flag_helper(object *objp, dock_function_info * /*infop*/ );
#endif // _OBJECT_DOCK_H
|
