electrical arc upgrade, stage 1: refactor data structures

Author: Goober5000

code/debris/debris.cpp

@@ -59,6 +59,8 @@ particle::ParticleEffectHandle Debris_hit_particle;
 
 #define	DEBRIS_INDEX(dp) (int)(dp-Debris.data())
 
+// Find the first available arc slot.
+debris_electrical_arc *debris_find_electrical_arc_slot(debris *db);
 
 /**
  * Start the sequence of a piece of debris writhing in unholy agony!!!
@@ -286,36 +288,36 @@ void debris_process_post(object * obj, float frame_time)
 
 			// Create the spark effects
 			for (int i=0; i<MAX_DEBRIS_ARCS; ++i)	{
-				if ( !db->arc_timestamp[i].isValid() )	{
+				auto arc = &db->electrical_arcs[i];
+				if ( !arc->timestamp.isValid() )	{
 
-					db->arc_timestamp[i] = _timestamp(lifetime);	// live up to a second
+					arc->timestamp = _timestamp(lifetime);	// live up to a second
 
 					switch( n )	{
 					case 0:
-						db->arc_pts[i][0] = v1;
-						db->arc_pts[i][1] = v2;
+						arc->endpoint_1 = v1;
+						arc->endpoint_2 = v2;
 						break;
 					case 1:
-						db->arc_pts[i][0] = v2;
-						db->arc_pts[i][1] = v3;
+						arc->endpoint_1 = v2;
+						arc->endpoint_2 = v3;
 						break;
 
 					case 2:
-						db->arc_pts[i][0] = v2;
-						db->arc_pts[i][1] = v4;
+						arc->endpoint_1 = v2;
+						arc->endpoint_2 = v4;
 						break;
 
 					default:
 						Int3();
 					}
-						
+
 					n++;
 					if ( n == n_arcs )
 						break;	// Don't need to create anymore
 				}
 			}
 
-	
 			// rotate v2 out of local coordinates into world.
 			// Use v2 since it is used in every bolt.  See above switch().
 			vec3d snd_pos;
@@ -342,16 +344,20 @@ void debris_process_post(object * obj, float frame_time)
 		}
 	}
 
-	for (int i=0; i<MAX_DEBRIS_ARCS; ++i)	{
-		if ( db->arc_timestamp[i].isValid() )	{
-			if ( timestamp_elapsed( db->arc_timestamp[i] ) )	{
+	for (auto &arc: db->electrical_arcs) {
+		if (arc.timestamp.isValid()) {
+			if (timestamp_elapsed(arc.timestamp)) {
 				// Kill off the spark
-				db->arc_timestamp[i] = TIMESTAMP::invalid();
+				arc.timestamp = TIMESTAMP::invalid();
 			} else {
 				// Maybe move a vertex....  20% of the time maybe?
 				int mr = Random::next();
 				if ( mr < Random::MAX_VALUE/5 )	{
-					db->arc_pts[i][mr % 2] = submodel_get_random_point(db->model_num, db->submodel_num);
+					auto pt = submodel_get_random_point(db->model_num, db->submodel_num);
+					if (mr % 2 == 0)
+						arc.endpoint_1 = pt;
+					else
+						arc.endpoint_2 = pt;
 				}
 			}
 		}
@@ -602,7 +608,7 @@ object *debris_create_only(int parent_objnum, int parent_ship_class, int alt_typ
 	db->damage_mult = 1.0f;
 
 	for (int i=0; i<MAX_DEBRIS_ARCS; ++i)	{	// NOLINT
-		db->arc_timestamp[i] = TIMESTAMP::invalid();
+		db->electrical_arcs[i].timestamp = TIMESTAMP::invalid();
 	}
 
 	if ( db->is_hull )	{
@@ -1168,7 +1174,7 @@ void calc_debris_physics_properties( physics_info *pi, vec3d *mins, vec3d *maxs,
 */
 void debris_render(object * obj, model_draw_list *scene)
 {
-	int			i, num, swapped;
+	int			num, swapped;
 	debris		*db;
 
 	swapped = -1;
@@ -1203,9 +1209,9 @@ void debris_render(object * obj, model_draw_list *scene)
 
 		// Only render electrical arcs if within 500m of the eye (for a 10m piece)
 		if ( vm_vec_dist_quick( &obj->pos, &Eye_position ) < obj->radius*50.0f )	{
-			for (i=0; i<MAX_DEBRIS_ARCS; i++ )	{
-				if ( db->arc_timestamp[i].isValid() )	{
-					model_instance_add_arc( pm, pmi, db->submodel_num, &db->arc_pts[i][0], &db->arc_pts[i][1], MARC_TYPE_DAMAGED );
+			for (auto &arc: db->electrical_arcs) {
+				if ( arc.timestamp.isValid() )	{
+					model_instance_add_arc( pm, pmi, db->submodel_num, &arc.endpoint_1, &arc.endpoint_2, MARC_TYPE_DAMAGED );
 				}
 			}
 		}
@@ -1256,3 +1262,19 @@ void create_generic_debris(object* ship_objp, const vec3d* pos, float min_num_de
 		debris_create(ship_objp, model_num, -1, &create_pos, pos, 0, speed_mult);
 	}
 }
+
+debris_electrical_arc *debris_find_electrical_arc_slot(debris *db)
+{
+	size_t i = 0;
+	for (auto& ii : db->electrical_arcs)
+	{
+		if (!ii.timestamp.isValid())
+			break;
+		i++;
+	}
+
+	if (i == MAX_DEBRIS_ARCS)
+		return nullptr;
+
+	return &db->electrical_arcs[i];
+}

code/debris/debris.h

@@ -30,6 +30,12 @@ FLAG_LIST(Debris_Flags) {
 	NUM_VALUES
 };
 
+struct debris_electrical_arc
+{
+	vec3d endpoint_1;
+	vec3d endpoint_2;
+	TIMESTAMP timestamp;	// When this times out, the spark goes away.  Invalid is not used
+};
 
 typedef struct debris {
 	flagset<Debris_Flags> flags;	// See DEBRIS_??? defines
@@ -50,8 +56,7 @@ typedef struct debris {
 	TIMESTAMP	sound_delay;		// timestamp to signal when sound should start
 	fix		time_started;			// time when debris was created
 
-	vec3d	arc_pts[MAX_DEBRIS_ARCS][2];	// The endpoints of each arc
-	TIMESTAMP	arc_timestamp[MAX_DEBRIS_ARCS];	// When this times out, the spark goes away.  Invalid is not used
+	debris_electrical_arc electrical_arcs[MAX_DEBRIS_ARCS];
 	int		arc_frequency;					// Starts at 1000, gets bigger
 
 	int		parent_alt_name;

code/model/model.h

@@ -96,6 +96,23 @@ extern const char *Subsystem_types[SUBSYSTEM_MAX];
 
 #define MAX_SPLIT_PLANE				5				// number of artist specified split planes (used in big ship explosions)
 
+// Electrical Arc Effect Info
+// Sets a spark for this submodel between vertex v1 and v2
+struct electrical_arc
+{
+	color	primary_color_1;
+	color	primary_color_2;
+	color	secondary_color;
+	float	width;								// only used for MARC_TYPE_SHIP and MARC_TYPE_SCRIPTED
+	vec3d	endpoint_1;
+	vec3d	endpoint_2;
+	ubyte	type;								// see MARC_TYPE_* defines
+};
+
+struct model_electrical_arc : electrical_arc
+{
+};
+
 // Data specific to a particular instance of a submodel.
 struct submodel_instance
 {
@@ -127,30 +144,16 @@ struct submodel_instance
 	vec3d	canonical_offset = vmd_zero_vector;
 	vec3d	canonical_prev_offset = vmd_zero_vector;
 
-	// --- these fields used to be in bsp_info ---
-
-	// Electrical Arc Effect Info
-	// Sets a spark for this submodel between vertex v1 and v2	
-	int		num_arcs = 0;											// See model_add_arc for more info	
-	color   arc_primary_color_1[MAX_ARC_EFFECTS];
-	color   arc_primary_color_2[MAX_ARC_EFFECTS];
-	color	arc_secondary_color[MAX_ARC_EFFECTS];
-	float	arc_width[MAX_ARC_EFFECTS];								// only used for MARC_TYPE_SHIP and MARC_TYPE_SCRIPTED
-	vec3d	arc_pts[MAX_ARC_EFFECTS][2];
-	ubyte		arc_type[MAX_ARC_EFFECTS];							// see MARC_TYPE_* defines
+	int		num_arcs = 0;											// See model_add_arc for more info
+	model_electrical_arc electrical_arcs[MAX_ARC_EFFECTS];
 
 	//SMI-Specific movement axis. Only valid in MOVEMENT_TYPE_TRIGGERED.
-	vec3d	rotation_axis;
-	vec3d	translation_axis;
+	vec3d	rotation_axis = vmd_zero_vector;
+	vec3d	translation_axis = vmd_zero_vector;
 
 	submodel_instance()
 	{
-		memset(&arc_pts, 0, MAX_ARC_EFFECTS * 2 * sizeof(vec3d));
-		memset(&arc_primary_color_1, 0, MAX_ARC_EFFECTS * sizeof(color));
-		memset(&arc_primary_color_2, 0, MAX_ARC_EFFECTS * sizeof(color));
-		memset(&arc_secondary_color, 0, MAX_ARC_EFFECTS * sizeof(color));
-		memset(&arc_type, 0, MAX_ARC_EFFECTS * sizeof(ubyte));
-		memset(&arc_width, 0, MAX_ARC_EFFECTS * sizeof(float));
+		memset(electrical_arcs, 0, MAX_ARC_EFFECTS * sizeof(model_electrical_arc));
 	}
 };
 

code/model/modelread.cpp

@@ -5221,15 +5221,16 @@ void model_instance_add_arc(polymodel *pm, polymodel_instance *pmi, int sub_mode
 	auto smi = &pmi->submodel[sub_model_num];
 
 	if ( smi->num_arcs < MAX_ARC_EFFECTS )	{
-		smi->arc_type[smi->num_arcs] = (ubyte)arc_type;
-		smi->arc_pts[smi->num_arcs][0] = *v1;
-		smi->arc_pts[smi->num_arcs][1] = *v2;
+		auto &new_arc = smi->electrical_arcs[smi->num_arcs];
+		new_arc.type = static_cast<ubyte>(arc_type);
+		new_arc.endpoint_1 = *v1;
+		new_arc.endpoint_2 = *v2;
 
 		if (arc_type == MARC_TYPE_SHIP || arc_type == MARC_TYPE_SCRIPTED) {
-			smi->arc_primary_color_1[smi->num_arcs] = *primary_color_1;
-			smi->arc_primary_color_2[smi->num_arcs] = *primary_color_2;
-			smi->arc_secondary_color[smi->num_arcs] = *secondary_color;
-			smi->arc_width[smi->num_arcs] = width;
+			new_arc.primary_color_1 = *primary_color_1;
+			new_arc.primary_color_2 = *primary_color_2;
+			new_arc.secondary_color = *secondary_color;
+			new_arc.width = width;
 		}
 
 		smi->num_arcs++;

code/model/modelrender.cpp

@@ -826,8 +826,10 @@ void model_render_add_lightning(model_draw_list *scene, const model_render_param
  	}
 
 	for ( i = 0; i < smi->num_arcs; i++ ) {
+		auto &arc = smi->electrical_arcs[i];
+
 		// pick a color based upon arc type
-		switch ( smi->arc_type[i] ) {
+		switch ( arc.type ) {
 			// "normal", FreeSpace 1 style arcs
 		case MARC_TYPE_DAMAGED:
 			if ( Random::flip_coin() )	{
@@ -853,14 +855,14 @@ void model_render_add_lightning(model_draw_list *scene, const model_render_param
 		case MARC_TYPE_SCRIPTED:
 		case MARC_TYPE_SHIP:
 			if ( Random::flip_coin() )	{
-				primary = smi->arc_primary_color_1[i];
+				primary = arc.primary_color_1;
 			} else {
-				primary = smi->arc_primary_color_2[i];
+				primary = arc.primary_color_2;
 			}
 
-			secondary = smi->arc_secondary_color[i];
+			secondary = arc.secondary_color;
 
-			width = smi->arc_width[i];
+			width = arc.width;
 
 			break;
 
@@ -887,12 +889,12 @@ void model_render_add_lightning(model_draw_list *scene, const model_render_param
 			break;
 
 		default:
-			UNREACHABLE("Unknown arc type of %d found in model_render_add_lightning(), please contact an SCP coder!", smi->arc_type[i]);
+			UNREACHABLE("Unknown arc type of %d found in model_render_add_lightning(), please contact an SCP coder!", arc.type);
 		}
 
 		// render the actual arc segment
 		if (width > 0.0f)
-			scene->add_arc(&smi->arc_pts[i][0], &smi->arc_pts[i][1], &primary, &secondary, width);
+			scene->add_arc(&arc.endpoint_1, &arc.endpoint_2, &primary, &secondary, width);
 	}
 }
 

code/object/object.cpp

@@ -1381,18 +1381,16 @@ void obj_move_all_post(object *objp, float frametime)
 			// Make any electrical arcs on ships cast light
 			if (Arc_light)	{
 				if ( (Detail.lighting > 3) && (objp != Viewer_obj) ) {
-					int i;
-					ship		*shipp;
-					shipp = &Ships[objp->instance];
+					auto shipp = &Ships[objp->instance];
 
-					for (i=0; i<MAX_ARC_EFFECTS; i++ )	{
-						if ( shipp->arc_timestamp[i].isValid() )	{
+					for (auto &arc: shipp->electrical_arcs) {
+						if ( arc.timestamp.isValid() )	{
 							// Move arc endpoints into world coordinates	
 							vec3d tmp1, tmp2;
-							vm_vec_unrotate(&tmp1,&shipp->arc_pts[i][0],&objp->orient);
+							vm_vec_unrotate(&tmp1,&arc.endpoint_1,&objp->orient);
 							vm_vec_add2(&tmp1,&objp->pos);
 
-							vm_vec_unrotate(&tmp2,&shipp->arc_pts[i][1],&objp->orient);
+							vm_vec_unrotate(&tmp2,&arc.endpoint_2,&objp->orient);
 							vm_vec_add2(&tmp2,&objp->pos);
 
 							light_add_point( &tmp1, 10.0f, 20.0f, frand(), 1.0f, 1.0f, 1.0f);
@@ -1478,19 +1476,17 @@ void obj_move_all_post(object *objp, float frametime)
 			// Make any electrical arcs on debris cast light
 			if (Arc_light)	{
 				if ( Detail.lighting > 3 ) {
-					int i;
-					debris		*db;
-					db = &Debris[objp->instance];
+					auto db = &Debris[objp->instance];
 
 					if (db->arc_frequency > 0) {
-						for (i=0; i<MAX_DEBRIS_ARCS; i++ )	{
-							if ( db->arc_timestamp[i].isValid() )	{
+						for (auto &arc: db->electrical_arcs) {
+							if ( arc.timestamp.isValid() )	{
 								// Move arc endpoints into world coordinates	
 								vec3d tmp1, tmp2;
-								vm_vec_unrotate(&tmp1,&db->arc_pts[i][0],&objp->orient);
+								vm_vec_unrotate(&tmp1,&arc.endpoint_1,&objp->orient);
 								vm_vec_add2(&tmp1,&objp->pos);
 
-								vm_vec_unrotate(&tmp2,&db->arc_pts[i][1],&objp->orient);
+								vm_vec_unrotate(&tmp2,&arc.endpoint_2,&objp->orient);
 								vm_vec_add2(&tmp2,&objp->pos);
 
 								light_add_point( &tmp1, 10.0f, 20.0f, frand(), 1.0f, 1.0f, 1.0f );

code/scripting/api/objs/ship.cpp

@@ -2773,24 +2773,24 @@ ADE_FUNC(AddElectricArc, l_Ship, "vector firstPoint, vector secondPoint, number
 	auto shipp = &Ships[objh->objp()->instance];
 
 	// spawn the arc in the first unused slot
-	for (int i = 0; i < MAX_ARC_EFFECTS; i++) {
-		if (!shipp->arc_timestamp[i].isValid()) {
-			shipp->arc_timestamp[i] = _timestamp(fl2i(duration * MILLISECONDS_PER_SECOND));
+	auto arc = ship_find_electrical_arc_slot(shipp);
+	if (arc)
+	{
+		arc->timestamp = _timestamp(fl2i(duration * MILLISECONDS_PER_SECOND));
 
-			shipp->arc_pts[i][0] = *v1;
-			shipp->arc_pts[i][1] = *v2;
+		arc->endpoint_1 = *v1;
+		arc->endpoint_2 = *v2;
 
-			//Set the arc colors
-			shipp->arc_primary_color_1[i] = Arc_color_damage_p1;
-			shipp->arc_primary_color_2[i] = Arc_color_damage_p2;
-			shipp->arc_secondary_color[i] = Arc_color_damage_s1;
+		//Set the arc colors
+		arc->primary_color_1 = Arc_color_damage_p1;
+		arc->primary_color_2 = Arc_color_damage_p2;
+		arc->secondary_color = Arc_color_damage_s1;
 
-			shipp->arc_type[i] = MARC_TYPE_SCRIPTED;
+		arc->type = MARC_TYPE_SCRIPTED;
 
-			shipp->arc_width[i] = width;
+		arc->width = width;
 
-			return ade_set_args(L, "i", i + 1);	// FS2 -> Lua
-		}
+		return ade_set_args(L, "i", static_cast<int>(arc - shipp->electrical_arcs) + 1);	// FS2 -> Lua
 	}
 
 	return ade_set_args(L, "i", 0);
@@ -2815,7 +2815,7 @@ ADE_FUNC(DeleteElectricArc, l_Ship, "number index",
 	index--;	// Lua -> FS2
 	if (index >= 0 && index < MAX_ARC_EFFECTS)
 	{
-		shipp->arc_timestamp[index] = TIMESTAMP::invalid();
+		shipp->electrical_arcs[index].timestamp = TIMESTAMP::invalid();
 	}
 
 	return ADE_RETURN_NIL;
@@ -2844,11 +2844,12 @@ ADE_FUNC(ModifyElectricArc, l_Ship, "number index, vector firstPoint, vector sec
 	index--;	// Lua -> FS2
 	if (index >= 0 && index < MAX_ARC_EFFECTS)
 	{
-		shipp->arc_pts[index][0] = *v1;
-		shipp->arc_pts[index][1] = *v2;
+		auto &arc = shipp->electrical_arcs[index];
+		arc.endpoint_1 = *v1;
+		arc.endpoint_2 = *v2;
 
 		if (args == 5)
-			shipp->arc_width[index] = width;
+			arc.width = width;
 	}
 
 	return ADE_RETURN_NIL;